-
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
docs: Fix missing download testdata section in documentation #1281
Conversation
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.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main-dev #1281 +/- ##
=========================================
Coverage 78.95% 78.95%
=========================================
Files 136 136
Lines 20829 20830 +1
=========================================
+ Hits 16445 16446 +1
Misses 4384 4384
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
The file name to be downloaded. | ||
extract_dir : | ||
An optional folder override to where to extract the file. By | ||
default files are extracted into `~/MyPyaerocom` |
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.
Wrong formatting, use rest or numpy: https://gist.github.com/nipunsadvilkar/fec9d2a40f9c83ea7fd97be59261c400 (in vscode, I like to use https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring )
"""
Download test_data_file and extracts it.
:param file_name: The file name to be downloaded.
:param extract_dir: An optional folder override to where to extract the file. By
default files are extracted into ~/MyPyaerocom
"""
should work.
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.
Still wrong formatting of parameters at https://pyaerocom--1281.org.readthedocs.build/en/1281/api.html#module-pyaerocom.sample_data_access.minimal_dataset after recents fix:formatting
:
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.
👍
Change Summary
Noticed that the section for downloading sample data in the documentation is currently blank. This PR should fix that:
https://pyaerocom.readthedocs.io/en/latest/api.html#access-to-minimal-test-dataset
Related issue number
NA
Checklist