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

Intelligently assign class/function docstrings #10

Open
agoose77 opened this issue May 6, 2021 · 1 comment
Open

Intelligently assign class/function docstrings #10

agoose77 opened this issue May 6, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@agoose77
Copy link
Owner

agoose77 commented May 6, 2021

Might need a way to disable this with a tag.

This may/may not be useful; a Google-style docstring would naturally work in Markdown, but shouldn't this be left inline with the function definition?

@agoose77 agoose77 changed the title Feature: let preceeding Markdown cells be used as docstrings Feature: intelligently assign class/function docstrings May 6, 2021
@agoose77 agoose77 changed the title Feature: intelligently assign class/function docstrings Intelligently assign class/function docstrings May 17, 2021
@agoose77 agoose77 added the enhancement New feature or request label May 17, 2021
@agoose77
Copy link
Owner Author

agoose77 commented Jun 25, 2021

I have thought more about this, and I think the benefits outweigh the negatives for supporting out-of-definition docstrings. The added readability + Markdown integration improves the use of a notebook rather than detracts from it.

It would be nice to integrate with https://github.com/Carreau/papyri and perhaps generate the appropriate IR from myst-markdown.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant