-
Notifications
You must be signed in to change notification settings - Fork 13
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
Feature: Added ability to pass directives in docstrings #956
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## develop #956 +/- ##
========================================
Coverage 66.59% 66.59%
========================================
Files 38 38
Lines 4425 4425
========================================
Hits 2947 2947
Misses 1478 1478
|
@@ -541,7 +543,7 @@ def validate_download_args( | |||
return True | |||
|
|||
|
|||
def get_unavailable_expressions( | |||
def _get_unavailable_expressions( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
eg. alternatively, this could have been changed by adding:
::docs::get_unavailable_expressions::sort_last
Currently functional directives-
As of now, all directives within a module are parsed together. i.e. it wouldn't matter if you were addressing some other function in a functions docstring.
For this reason, it is recommended to list these directives in the module docstring.
Future directives can include highlighting, more sorting, and even appending examples