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

Update string_view docs #100

Closed
Lastique opened this issue Oct 31, 2021 · 5 comments
Closed

Update string_view docs #100

Lastique opened this issue Oct 31, 2021 · 5 comments

Comments

@Lastique
Copy link
Member

The header path is no longer correct:

[section Header <boost/core/string_view.hpp>]

Also, it would be a good idea to mention that boost::core::string_view is not intended to be used by users (hence it is in detail) and is supposed to be used by Boost library writers.

@glenfe
Copy link
Member

glenfe commented Oct 31, 2021

I don't think string_view.qbk is processed (since it isn't included in core.qbk) so no HTML etc. is generated for it.

@pdimov
Copy link
Member

pdimov commented Oct 31, 2021

string_view.qbk is no longer included. I just didn't delete it but I will if you insist.

@Lastique
Copy link
Member Author

Lastique commented Nov 1, 2021

Sorry, I didn't notice the docs were not included.

I don't insist on removing the docs, just asking to make it actual. If you intend to make it available, even if for library maintainers only, it should point to the right headers and provide guidance to the reader. If you're not going to publish the docs, I don't see the point in keeping them, but I'm fine if you want to keep them for some reason.

@pdimov
Copy link
Member

pdimov commented Nov 1, 2021

The future of string views is still unclear, so this documentation might still come into use, once we (Boost) figure out what we want and in which library and namespace we want it.

@Lastique
Copy link
Member Author

Lastique commented Nov 1, 2021

Ok, feel free to close this if you don't intend to update the docs at the moment.

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

3 participants