-
Notifications
You must be signed in to change notification settings - Fork 80
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
feat(tactic): make docstrings of imported modules accessible #81
Conversation
Cool, thanks!
I think a list would be better. No reason to throw away information about how they're separated. Even better: would it be possible to pair each docstring with its location in the file? |
The motivation there is that when we're generating docs, it would be nice to have some kind of sectioning. Module docs in the middle of the file would be the easiest way to do this. But we need to know where to put them in the generated docs. |
It's now a list of |
Here is a possible log entry for this:
|
19760af
to
5f0bb4f
Compare
New version adds |
Hm, that CI failure is really quite mysterious. I have no clue why this PR would change the column number printed in an unrelated test, and only on MacOS of all things. |
It's yet another instance of #72. It should go away if the job is re-run. @cipher1024 |
I haven't pushed it yet (still needs some cleanup), but I updated my doc generation tool to use this. Worked exactly as expected. Thanks again! |
Changes the semantics of
module_doc_strings
to contain a list of(some filename, top-level-docstring)
pairs, plus a(none, top-level-docstring)
for the current module. If a single module contains multiple top-level docstrings, they're concatenated with newlines (but I could make it a list like before if people want). Declaration docstrings are no longer present in the output, since they're accessible viadoc_string
anyway.CC @robertylewis