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

Avoid auto in docs introduction #83

Closed
akrzemi1 opened this issue Sep 22, 2023 · 0 comments · Fixed by #85
Closed

Avoid auto in docs introduction #83

akrzemi1 opened this issue Sep 22, 2023 · 0 comments · Fixed by #85

Comments

@akrzemi1
Copy link
Member

The initial docs examples use auto as i n:

auto r = boost::charconv::from_chars(buffer, buffer + std::strlen(buffer), v);

I recommend spelling out the return type:

boost::charconv::from_chars_result r = boost::charconv::from_chars(buffer, buffer + std::strlen(buffer), v);

It will make it clear for the person that first reads the introduction that the return type is also part of this library, as opposed to using another Boost library or a component from STD.

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

Successfully merging a pull request may close this issue.

1 participant