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

Minor improvements to contributing guide #1712

Closed
wants to merge 2 commits into from

Conversation

dstansby
Copy link
Contributor

  • Highlight code with bash highlighting
  • Fix highlighting in markdown code block
  • Remove leading "$" in code blocks to make it easier to copy/paste commands
  • Add quotes around [docs] so that the command works as intended in zsh.
  • Remove open command in doc building section, as this command is only available on macOS.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@@ -246,9 +245,9 @@ notes (``docs/release.rst``).

The documentation can be built locally by running::

$ cd docs
$ make clean; make html
$ open _build/html/index.html
Copy link
Member

Choose a reason for hiding this comment

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

How about instead of removing open _build/html/index.html, we add xdg-open for Linux?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'd be minded not to include because then there would have to be multiple commands for each OS, and I'm not sure there is even one for Windows?

$ open _build/html/index.html
cd docs
make clean
make html
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
make html
make html
open _build/html/index.html #macos
xdg-open _build/html/index.html #linux

Maybe something like this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Again, I it's best to leave out so there's code that works on all operating systems that you can just copy/paste.

Copy link

codecov bot commented Oct 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.98%. Comparing base (559c2e3) to head (ffc76fa).
Report is 257 commits behind head on v3.

Additional details and impacted files
@@           Coverage Diff           @@
##               v3    #1712   +/-   ##
=======================================
  Coverage   99.98%   99.98%           
=======================================
  Files          38       38           
  Lines       14718    14718           
=======================================
  Hits        14716    14716           
  Misses          2        2           

@jhamman jhamman added the V2 Affects the v2 branch label Oct 11, 2024
@jhamman jhamman changed the base branch from main to v3 October 11, 2024 23:34
@jhamman
Copy link
Member

jhamman commented Oct 11, 2024

@dstansby - would you be willing to take another pass on this w.r.t. our v3 dev process (hatch, etc)?

@dstansby
Copy link
Contributor Author

I think that would be sufficiently different (and I've never used hatch personally) to be worth rebasing this PR, so I'll close

@dstansby dstansby closed this Oct 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
V2 Affects the v2 branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants