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

docs: Fix missing download testdata section in documentation #1281

Merged
merged 5 commits into from
Jul 26, 2024

Conversation

thorbjoernl
Copy link
Collaborator

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

  • Start with a draft-PR
  • The PR title is a good summary of the changes
  • PR is set to AeroTools and a tentative milestone
  • Documentation reflects the changes where applicable
  • Tests for the changes exist where applicable
  • Tests pass locally
  • Tests pass on CI
  • At least 1 reviewer is selected
  • Make PR ready to review

@thorbjoernl thorbjoernl added the documentation Everything related to code documentation, tutorials and examples label Jul 26, 2024
@thorbjoernl thorbjoernl added this to the m2024-08 milestone Jul 26, 2024
@thorbjoernl thorbjoernl self-assigned this Jul 26, 2024
@thorbjoernl thorbjoernl marked this pull request as ready for review July 26, 2024 11:26
Copy link
Member

@heikoklein heikoklein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link

codecov bot commented Jul 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.95%. Comparing base (a6eb787) to head (db12514).
Report is 7 commits behind head on main-dev.

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           
Flag Coverage Δ
unittests 78.95% <100.00%> (+<0.01%) ⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@thorbjoernl thorbjoernl marked this pull request as draft July 26, 2024 11:41
@thorbjoernl thorbjoernl marked this pull request as ready for review July 26, 2024 11:52
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`
Copy link
Member

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.

Copy link
Member

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:
image

should look like:
image

@heikoklein heikoklein self-requested a review July 26, 2024 12:25
Copy link
Member

@heikoklein heikoklein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@heikoklein heikoklein merged commit ba9431c into main-dev Jul 26, 2024
6 checks passed
@thorbjoernl thorbjoernl deleted the fix-missing-documentation-section branch August 19, 2024 08:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Everything related to code documentation, tutorials and examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants