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

Wishlist: delimit docs-only section #53

Open
chrysn opened this issue Sep 22, 2020 · 0 comments
Open

Wishlist: delimit docs-only section #53

chrysn opened this issue Sep 22, 2020 · 0 comments

Comments

@chrysn
Copy link

chrysn commented Sep 22, 2020

When a crate's documentation contains a point from where on it is not practical to include in the README any more, it would be convenient to add a magic marker (say, <!-- END OF README PART -->) into the text and cut it there.

For example, in https://gitlab.com/etonomy/riot-sys, the main part is about building and integration which is all good, but where it cuts to what is in the main crate vs. what is in pub modules, this belongs into the docs but not the README.

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

1 participant