DOC Added link to raise issue and view source code #1329
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
romanlutz
reviewed
Jan 3, 2024
| @@ -64,3 +64,7 @@ ReST to markdown by sphinx-gallery. This currently only works for basic ReST | |||
| functionality, so try to limit use of ReST directives (e.g., `.. note::`), | |||
| internal links (e.g., `:ref:`), and other functionality that won't render well | |||
| in markdown. | |||
|
|
|||
|
|
|||
| .. note:: | |||
There was a problem hiding this comment.
These are rst files, not the examples themselves. The issue is about adding these notes to the examples.
There was a problem hiding this comment.
Ohh, I understand. I need to add # before each line if I put the note in .py, right?
romanlutz
reviewed
Jan 4, 2024
|
|
||
|
|
||
| #.. note:: | ||
| # |edit| `View source <https://github.com/fairlearn/fairlearn/blob/main/examples/plot_grid_search_census.py>`to the code file or `open issue <https://github.com/fairlearn/fairlearn/issues/new?>`__. |
There was a problem hiding this comment.
Suggested change
| # |edit| `View source <https://github.com/fairlearn/fairlearn/blob/main/examples/plot_grid_search_census.py>`to the code file or `open issue <https://github.com/fairlearn/fairlearn/issues/new?>`__. | |
| # |edit| `View source <https://github.com/fairlearn/fairlearn/blob/main/examples/plot_grid_search_census.py>` or `open issue <https://github.com/fairlearn/fairlearn/issues/new?>`__. |
Small suggestion for this file and others.
Did you build the docs to see if it worked as intended?
There was a problem hiding this comment.
Is there any way to put the note in rst or html file for the notebook examples? Putting it in .py file just makes it a part of the examples rather than making a note.
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.
Issue: #1301