You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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?
The text was updated successfully, but these errors were encountered:
agoose77
changed the title
Feature: let preceeding Markdown cells be used as docstrings
Feature: intelligently assign class/function docstrings
May 6, 2021
agoose77
changed the title
Feature: intelligently assign class/function docstrings
Intelligently assign class/function docstrings
May 17, 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.
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?
The text was updated successfully, but these errors were encountered: