Topic: Document the workflows & code #16
Open
+104
−28
Conversation
This file contains hidden or 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
elisehellwig
requested changes
Nov 20, 2025
| bundling all of the commands in a workflow into a single command. | ||
|
|
||
|
|
||
| ### Make Workflow Diagrams |
Contributor
There was a problem hiding this comment.
You might consider mentioning how workflow diagrams can happen at different "levels", the function level, the script level, the workflow level etc. I often find I have one overarching workflow diagram and then more detailed diagrams of individual steps in the overarching diagram.
| inputs, assumptions, outputs, and any pitfalls. If the code is organized into | ||
| functions, do the same for each function. | ||
|
|
||
| Comments are a good way to document code, but some programming languages also |
Contributor
There was a problem hiding this comment.
I would differentiate between using comments to state in plain english what a given line of code is trying to accomplish and documenting the purpose of a script or function at the top of it. While these two things are related, they are often useful in different settings and doing one does not absolve you from doing the other.
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.
This PR adds text for the topic "Document the workflows & code."
Feedback appreciated!