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

List in documentation the "high level" interfaces corresponding to CLI #1200

Merged
merged 4 commits into from
Feb 22, 2023

Conversation

yarikoptic
Copy link
Member

as consequence, lower the other two levels to Mid/Low levels (unless there is objection)

but how to point to the specific functions (e.g. download.download) instead of full modref -- @jwodder could you make it happen since I have tried some ways and keep making sphinx unhappy

…to CLI

And plugged in brief descriptions on what is the difference between those levels.

Note -- FTBFS atm with

	Warning, treated as error:
	/home/yoh/proj/dandi/dandi-cli-master/docs/source/modref/generated/dandi.validate.rst:12:Inline emphasis start-string without end-string.

which I do not get why.
@codecov
Copy link

codecov bot commented Feb 2, 2023

Codecov Report

Base: 89.16% // Head: 89.16% // No change to project coverage 👍

Coverage data is based on head (bab0de9) compared to base (e81be32).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1200   +/-   ##
=======================================
  Coverage   89.16%   89.16%           
=======================================
  Files          76       76           
  Lines        9471     9471           
=======================================
  Hits         8445     8445           
  Misses       1026     1026           
Flag Coverage Δ
unittests 89.16% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
dandi/delete.py 90.90% <ø> (ø)
dandi/validate.py 97.87% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@jwodder
Copy link
Member

jwodder commented Feb 2, 2023

@yarikoptic I can't figure out how to get linking to functions to work.

docs/source/modref/index.rst Outdated Show resolved Hide resolved
Co-authored-by: John T. Wodder II <jwodder@users.noreply.github.com>
@yarikoptic
Copy link
Member Author

ok, let's proceed as is for now. May be will improve (point to specific functions) later.

@yarikoptic yarikoptic added the documentation Changes only affect the documentation label Feb 22, 2023
@yarikoptic yarikoptic merged commit 5ef6204 into master Feb 22, 2023
@yarikoptic yarikoptic deleted the enh-python-interfaces branch February 22, 2023 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants