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

Feature: Added ability to pass directives in docstrings #956

Merged
merged 16 commits into from
Sep 6, 2023

Conversation

Magnus167
Copy link
Member

@Magnus167 Magnus167 commented Sep 6, 2023

Currently functional directives-

::docs::function_name::sort_first::
::docs::function_name::sort_last::

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

@codecov
Copy link

codecov bot commented Sep 6, 2023

Codecov Report

Merging #956 (ee08018) into develop (5bcd561) will not change coverage.
Report is 1 commits behind head on develop.
The diff coverage is 75.00%.

❗ Current head ee08018 differs from pull request most recent head e68eb3e. Consider uploading reports for the commit e68eb3e to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #956   +/-   ##
========================================
  Coverage    66.59%   66.59%           
========================================
  Files           38       38           
  Lines         4425     4425           
========================================
  Hits          2947     2947           
  Misses        1478     1478           
Files Changed Coverage Δ
macrosynergy/download/jpmaqs.py 84.46% <ø> (ø)
macrosynergy/management/check_availability.py 37.80% <ø> (ø)
...rosynergy/management/simulate_quantamental_data.py 87.24% <ø> (ø)
macrosynergy/management/update_df.py 69.35% <ø> (ø)
macrosynergy/panel/basket.py 77.14% <ø> (ø)
macrosynergy/panel/converge_row.py 100.00% <ø> (ø)
macrosynergy/panel/historic_vol.py 79.81% <ø> (ø)
macrosynergy/panel/make_blacklist.py 65.57% <ø> (ø)
macrosynergy/panel/make_relative_value.py 81.55% <ø> (ø)
macrosynergy/panel/make_zn_scores.py 78.89% <ø> (ø)
... and 4 more

Impacted file tree graph

@@ -541,7 +543,7 @@ def validate_download_args(
return True


def get_unavailable_expressions(
def _get_unavailable_expressions(
Copy link
Member Author

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

@Magnus167 Magnus167 linked an issue Sep 6, 2023 that may be closed by this pull request
@Magnus167 Magnus167 merged commit ff0c2a8 into develop Sep 6, 2023
3 checks passed
@Magnus167 Magnus167 deleted the feature/doc_directive branch September 6, 2023 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation upgrade
2 participants