Sbachmei/mic 5561/docstring linking #141
Merged
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
Base automatically changed from
sbachmei/mic-5561/improve-docstrings-graph_components-implementation
to
main
January 8, 2025 18:24
stevebachmeier
force-pushed
the
sbachmei/mic-5561/docstring-linking
branch
from
7e50cd2 to
b657e22
Compare
stevebachmeier
commented
Jan 8, 2025
| @@ -1,3 +1,12 @@ | |||
| .wy-nav-content { | |||
| max-width: 1000px !important; | |||
| } | |||
| /* make links red and bold */ | |||
| code.xref { | |||
There was a problem hiding this comment.
This makes cross-references (which I think are only things like :class:, :meth:, etc) red instead of black
stevebachmeier
requested review from
aflaxman,
albrja,
hussain-jafari,
patricktnast,
rmudambi and
zmbc
as code owners
rmudambi
approved these changes
Jan 10, 2025
src/easylink/configuration.py
Outdated
Comment on lines
55
to
56
| A ``Config`` is a container that includes the combination of the user-provided | ||
| pipeline, input data, and computing environment specifications. It is a nested |
There was a problem hiding this comment.
Nit:
Suggested change
| A ``Config`` is a container that includes the combination of the user-provided | |
| pipeline, input data, and computing environment specifications. It is a nested | |
| A ``Config`` is an object that contains the user-provided specifications for the | |
| pipeline, input data, and computing environment. It is a nested |
|
|
||
| Parameters | ||
| ---------- | ||
| pipeline_specification | ||
| The path to the pipeline specification yaml file. | ||
| The path to the pipeline specification file. |
There was a problem hiding this comment.
Do we say somewhere else what these specifications files are supposed to look like?
There was a problem hiding this comment.
Not yet, no. I'd imagine that will show up in a concept or the quickstart or soemthing at some point. I just didn't feel the need to specify yaml here in case it ever does change or we support different formats
patricktnast
approved these changes
Jan 10, 2025
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.
Improve docstring linking
Description
Changes and notes
We agreed as a team that the first mention of an external object should belinked and then all others can simply be double backticked. This does that.
I also reversed the colors between a linked object and highlighed so that
links are red and highlighted (double backticked) are black.
Verification and Testing