Minor improvements to contributing guide #1712
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MSanKeys963
reviewed
Mar 24, 2024
| @@ -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 | |||
There was a problem hiding this comment.
How about instead of removing open _build/html/index.html, we add xdg-open for Linux?
There was a problem hiding this comment.
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?
MSanKeys963
reviewed
Mar 24, 2024
| $ open _build/html/index.html | ||
| cd docs | ||
| make clean | ||
| make html |
There was a problem hiding this comment.
Suggested change
| make html | |
| make html | |
| open _build/html/index.html #macos | |
| xdg-open _build/html/index.html #linux |
Maybe something like this?
There was a problem hiding this comment.
Again, I it's best to leave out so there's code that works on all operating systems that you can just copy/paste.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[docs]so that the command works as intended inzsh.opencommand in doc building section, as this command is only available on macOS.TODO: