oj icon indicating copy to clipboard operation
oj copied to clipboard

Parser options documentation formatting error

Open semaperepelitsa opened this issue 1 year ago • 3 comments

Is it possible to fix the formatting? This is from the official documentation website: http://www.ohler.com/oj/doc/Oj/Parser.html

Screenshot 2023-11-21 at 15 30 17

semaperepelitsa avatar Nov 21 '23 08:11 semaperepelitsa

May I also suggest to make it more concise by describing attribute as a whole instead of getter/setter methods individually.

Before

  • cache_strings= sets the value of the cache_strings to a positive integer less than 35. Strings shorter than that length are cached.
  • cache_strings returns the value of the cache_strings integer value.

After

  • cache_strings - positive integer less than 35, strings shorter than that length are cached.

semaperepelitsa avatar Nov 21 '23 08:11 semaperepelitsa

It looks like the clang-formatter and the yardoc don't get along well with each other. I'll see what I can do.

ohler55 avatar Nov 21 '23 14:11 ohler55

Your suggestion on the combining of foo and foo= makes sense. I'll do that tonight.

ohler55 avatar Nov 21 '23 19:11 ohler55