Skip to content

Tweak format and wording of contributor doc#566

Merged
mfisher87 merged 8 commits intodevelopmentfrom
tweak-contributor-doc
Aug 26, 2024
Merged

Tweak format and wording of contributor doc#566
mfisher87 merged 8 commits intodevelopmentfrom
tweak-contributor-doc

Conversation

@mfisher87
Copy link
Copy Markdown
Member

@mfisher87 mfisher87 commented Aug 15, 2024

Split off from #565. Thank goodness for cherry-pick :)

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Aug 15, 2024

Binder 👈 Launch a binder notebook on this branch for commit 4791216

I will automatically update this comment whenever this PR is modified

Binder 👈 Launch a binder notebook on this branch for commit 23bd5c1

Binder 👈 Launch a binder notebook on this branch for commit 19e5a5b

Binder 👈 Launch a binder notebook on this branch for commit 59d4355

@mfisher87 mfisher87 marked this pull request as draft August 15, 2024 14:19
@codecov
Copy link
Copy Markdown

codecov Bot commented Aug 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.37%. Comparing base (e491c84) to head (59d4355).
Report is 28 commits behind head on development.

Additional details and impacted files
@@             Coverage Diff              @@
##           development     #566   +/-   ##
============================================
  Coverage        65.37%   65.37%           
============================================
  Files               36       36           
  Lines             3038     3038           
  Branches           531      531           
============================================
  Hits              1986     1986           
  Misses             970      970           
  Partials            82       82           

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


🚨 Try these New Features:

Comment thread doc/source/contributing/how_to_contribute.rst
@@ -94,10 +102,10 @@ environment (from the home level of your local copy of the icepyx repo) with

mamba env create --name icepyx-env --channel conda-forge -f requirements-dev.txt -f requirements.txt
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Any idea how easy it is to add the interactive "copy" button to the rendered version of this? Definitely not something we should hold up this PR for, but this caught my eye during review as a spot that would be nice to have.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I think that's a pretty easy change with a plugin: https://sphinx-copybutton.readthedocs.io/en/latest/

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Member

@JessicaS11 JessicaS11 left a comment

Choose a reason for hiding this comment

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

Looks great - thanks Matt!

@mfisher87 mfisher87 merged commit 2790edd into development Aug 26, 2024
@mfisher87 mfisher87 deleted the tweak-contributor-doc branch August 26, 2024 19:37
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