Add and fix various docstrings and comments ✍️ #1478
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
googlebot
added
the
cla: yes
tekton-robot
added
the
size/M
|
/lgtm |
While working on tektoncd#1417, which we decided in the end not to merge, I made a bunch of updates to docstrings and comments which are now in this commit: - Adding more detail to some docstrings - Adding missing docstrings - Updating docstrings that were sometimes wrong (e.g. a function name had changed) - Removing some comments in the Conditions logic that were no longer accurate - Added comments in some sections of code that took me a while to understand to hopefully make it faster next time :)
bobcatfish
force-pushed
the
addin_docstrings
branch
from
5716cf7
to
6047b3a
Compare
|
/lgtm |
|
👀 |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dlorenc The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
tekton-robot
added
the
approved
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.
Changes
While working on #1417, which we decided in the end not to merge, I made
a bunch of updates to docstrings and comments which are now in this
commit:
had changed)
accurate
understand to hopefully make it faster next time :)
Also maniacally added some periods 😅 😇
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
See the contribution guide for more details.
Double check this list of stuff that's easy to miss:
cmddir, please updatethe release Task to build and release this image.
Reviewer Notes
If API changes are included, additive changes must be approved by at least two OWNERS and backwards incompatible changes must be approved by more than 50% of the OWNERS, and they must first be added in a backwards compatible way.