Documentation of Reline #598
Labels
enhancement
New feature or request
Comments
|
My opinion: document in README directly first, and then create more specific |
|
I think important thing can be written in README. How to customize color can be also in IRB, with simple description and a link to Reline's document. |
hasumikin
added a commit
to hasumikin/reline
that referenced
this issue
Nov 6, 2023
hasumikin
added a commit
that referenced
this issue
Nov 6, 2023
…552) * Reine::Face * fix test_yamatanooroti * Define singleton methods to make accessors to attributes of a face * s/display/foreground/ * s/default/default_style/ && s/normal_line/default/ && s/enhanced_line/enhanced/ * fix typo * FaceConfig.new now takes keyword arguments * Update lib/reline/face.rb Co-authored-by: Stan Lo <[email protected]> * Update test/reline/test_face.rb Co-authored-by: Stan Lo <[email protected]> * Fix to correspond to frozen_string_literal * Face::FaceConfig -> Face::Config * ref #552 (review) * delete unused ivar * ref #552 (comment) * insert "\e[0m" into all SGR * tiny fix * ESSENTIAL_DEFINE_NAMES ref #552 (comment) * Change to Hash-accessor style - Reline::Face[:completion_dialog].enhanced -> Reline::Face[:completion_dialog][:enhanced] - Reline::Face.configs shows all defined values * Cache array method call in local variable * Tests for Face configuration variations * resolve #552 (review) * amend to * check invalid SGR parameter in :style * The order of define values should be preserved * Update test/reline/test_face.rb Co-authored-by: Stan Lo <[email protected]> * Update test/reline/test_face.rb Co-authored-by: Stan Lo <[email protected]> * Add methods: load_initial_config and reset_to_initial_config. And teardown in tests * omission in amending "style: :default" to "style: :reset" * refs #598 * Fix link * amend method name * Update lib/reline/face.rb Co-authored-by: ima1zumi <[email protected]> --------- Co-authored-by: Stan Lo <[email protected]> Co-authored-by: ima1zumi <[email protected]>
matzbot
pushed a commit
to ruby/ruby
that referenced
this issue
Nov 6, 2023
character attributes (ruby/reline#552) * Reine::Face * fix test_yamatanooroti * Define singleton methods to make accessors to attributes of a face * s/display/foreground/ * s/default/default_style/ && s/normal_line/default/ && s/enhanced_line/enhanced/ * fix typo * FaceConfig.new now takes keyword arguments * Update lib/reline/face.rb Co-authored-by: Stan Lo <[email protected]> * Update test/reline/test_face.rb Co-authored-by: Stan Lo <[email protected]> * Fix to correspond to frozen_string_literal * Face::FaceConfig -> Face::Config * ref ruby/reline#552 (review) * delete unused ivar * ref ruby/reline#552 (comment) * insert "\e[0m" into all SGR * tiny fix * ESSENTIAL_DEFINE_NAMES ref ruby/reline#552 (comment) * Change to Hash-accessor style - Reline::Face[:completion_dialog].enhanced -> Reline::Face[:completion_dialog][:enhanced] - Reline::Face.configs shows all defined values * Cache array method call in local variable * Tests for Face configuration variations * resolve ruby/reline#552 (review) * amend to * check invalid SGR parameter in :style * The order of define values should be preserved * Update test/reline/test_face.rb Co-authored-by: Stan Lo <[email protected]> * Update test/reline/test_face.rb Co-authored-by: Stan Lo <[email protected]> * Add methods: load_initial_config and reset_to_initial_config. And teardown in tests * omission in amending "style: :default" to "style: :reset" * refs ruby/reline#598 * Fix link * amend method name * Update lib/reline/face.rb Co-authored-by: ima1zumi <[email protected]> --------- ruby/reline@fdc1d3b1e5 Co-authored-by: Stan Lo <[email protected]> Co-authored-by: ima1zumi <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
ref #552 (comment)
Our team has been working on quite a lot of development, to the point where we need to start writing some documents.
Where to doc?
candidates:
Simplest way. As the number of descriptions increases, the file may become harder to read
like https://github.com/ruby/csv/tree/master/doc/csv
I prefer the latter.
What to doc?
any other things?
How to doc?
The text was updated successfully, but these errors were encountered: