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

DOC: small improvements to docs #150

Merged
merged 9 commits into from
Aug 30, 2024

Conversation

theroggy
Copy link
Contributor

@theroggy theroggy commented Aug 28, 2024

  • In python api docs of exact_extract:
    • Add link to "Available operations" to description of parameter ops.
    • Add link to the relevant section in the "Performance" to the description of parameter strategy.
  • Clarify descriptions of operation arguments default_value and default_weight: reference Make include_nodata argument available for built-in operations #147 (comment)
  • In "index" page: change to exactextract being "accurate" description so it is applicable to more use cases.
  • In "Installation" page, add conda as installation option.
  • Set width : 100% on the table with all operations to rather have the description become multi-line on smaller screens than horizontal scrolbars appearing

@theroggy theroggy changed the title Add link to "Available operations" in api doc DOC: small improvements Aug 28, 2024
@theroggy theroggy changed the title DOC: small improvements DOC: small improvements to docs Aug 28, 2024
Copy link

codecov bot commented Aug 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.03%. Comparing base (8bec482) to head (6e7e53a).
Report is 11 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #150   +/-   ##
=======================================
  Coverage   91.02%   91.03%           
=======================================
  Files          85       85           
  Lines        6398     6404    +6     
  Branches      627      628    +1     
=======================================
+ Hits         5824     5830    +6     
  Misses        542      542           
  Partials       32       32           

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

@dbaston
Copy link
Member

dbaston commented Aug 28, 2024

Thanks, these look like good changes to me. Do you intend to have it marked as "draft" ?

@theroggy
Copy link
Contributor Author

theroggy commented Aug 29, 2024

Thanks, these look like good changes to me. Do you intend to have it marked as "draft" ?

Yes, I'm still reading the docs, so might encounter other small things

I also wasn't 100% sure about the syntax for the link to "Avalable operations", so wanted to verify when docs were built in this PR... and apparently there is something wrong: the link works in the standard API reference page but it doesn't in the autoapi generated one, probably because it is deeper in the directory tree there...
Still need to look into that...

@dbaston
Copy link
Member

dbaston commented Aug 29, 2024

Looks good now

image

@theroggy
Copy link
Contributor Author

Looks good now

Indeed, now the link works in both situations...

@theroggy theroggy marked this pull request as ready for review August 29, 2024 19:59
@theroggy theroggy marked this pull request as draft August 29, 2024 22:00
@theroggy theroggy marked this pull request as ready for review August 30, 2024 05:27
@dbaston dbaston merged commit 80c2f82 into isciences:master Aug 30, 2024
24 checks passed
@dbaston
Copy link
Member

dbaston commented Aug 30, 2024

Thanks for the careful review and corrections!

@theroggy theroggy deleted the DOC-small-improvements-to-doc branch August 30, 2024 18:35
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.

2 participants