Skip to content
New issue

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

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

Already on GitHub? # to your account

Footnote based doc embedding #2

Open
pnkfelix opened this issue Jul 29, 2015 · 0 comments
Open

Footnote based doc embedding #2

pnkfelix opened this issue Jul 29, 2015 · 0 comments

Comments

@pnkfelix
Copy link
Owner

niko points out that embedding the documentation into comments directly in place (as is currently done in tango) breaks up the flow of the code significantly. When you're looking at the .rs file, you probably want to focus on the code itself, not the documentation.

One way to deal with this would be to stop embedding each block of documentation into a comment at that place, and instead emit a comment that just references a footnote. And then emit all the documentation, with the footnotes, at the end.

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

No branches or pull requests

1 participant