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

Documentation comments from Reuben #131

Closed
mborland opened this issue Jan 23, 2024 · 0 comments · Fixed by #145
Closed

Documentation comments from Reuben #131

mborland opened this issue Jan 23, 2024 · 0 comments · Fixed by #145
Labels
documentation Improvements or additions to documentation

Comments

@mborland
Copy link
Member

Minor comments on documentation:

  • The first example uses to_chars(... sizeof(buffer) - 1), which seems
    to imply a NULL-terminator somewhere. Since there is none, I think it
    should just be sizeof(buffer).
  • Docs don't specify the behavior about NULL-terminators. Either
    specify "adheres to standard" or clarify that no NULL-terminator is
    written.
  • IMO the front page should clearly state that this library is
    compliant with the charconv standard header, noting any exceptions.
  • from_chars overview is missing semicolons in the friends section.
  • Please use monospace in the discussion to refer to identifiers, like
    [first, last).
  • Basic usage: from_chars name is qualified but from_chars_result is not.
  • Code snippets wrap, which makes them difficult to read.

cc: @anarthal

@mborland mborland added the documentation Improvements or additions to documentation label Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant