Skip to content

Conversation

@FedericoNegri
Copy link
Contributor

image

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 6, 2024
@FedericoNegri FedericoNegri marked this pull request as ready for review March 6, 2024 08:46
@FedericoNegri FedericoNegri requested a review from PipKat March 6, 2024 08:46
@codecov
Copy link

codecov bot commented Mar 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.82%. Comparing base (daf8ccb) to head (6863a8d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #353   +/-   ##
=======================================
  Coverage   92.82%   92.82%           
=======================================
  Files          61       61           
  Lines        2258     2258           
=======================================
  Hits         2096     2096           
  Misses        162      162           

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

@PipKat
Copy link
Member

PipKat commented Mar 6, 2024

@FedericoNegri To follow our standard content structure, you need to move the card for the "API reference" section before the card for the "Examples" section. (I already made a suggested edit to the toc in the overall index.rst file to do this reordering.) Also, you need to add a card to the end for the "Contribute" section:
``.. grid-item-card:: Contribute :fa:people-group
:padding: 2 2 2 2
🔗 contributing
:link-type: doc

    Learn how to contribute to the PyHPS codebase
    or documentation.

Copy link
Member

@PipKat PipKat left a comment

Choose a reason for hiding this comment

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

Some minor edits.

@FedericoNegri
Copy link
Contributor Author

@FedericoNegri To follow our standard content structure, you need to move the card for the "API reference" section before the card for the "Examples" section. (I already made a suggested edit to the toc in the overall index.rst file to do this reordering.) Also, you need to add a card to the end for the "Contribute" section: ``.. grid-item-card:: Contribute :fa:people-group :padding: 2 2 2 2 🔗 contributing :link-type: doc

    Learn how to contribute to the PyHPS codebase
    or documentation.

done, thanks

@FedericoNegri FedericoNegri merged commit 950444d into main Mar 6, 2024
@FedericoNegri FedericoNegri deleted the fnegri/start_page branch March 6, 2024 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants