Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parser options documentation formatting error #903

Open
semaperepelitsa opened this issue Nov 21, 2023 · 3 comments
Open

Parser options documentation formatting error #903

semaperepelitsa opened this issue Nov 21, 2023 · 3 comments

Comments

@semaperepelitsa
Copy link

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
Copy link
Author

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.

@ohler55
Copy link
Owner

ohler55 commented Nov 21, 2023

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
Copy link
Owner

ohler55 commented Nov 21, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants