This repository was archived by the owner on Nov 10, 2025. It is now read-only.
updated the docstrings of template generator/validator #186
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
guicho271828
requested review from
mvcrouse,
pavan046 and
sivasankalpp
as code owners
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Related Issue
Supports #ISSUE_NUMBER
Related PRs
This PR is not dependent on any other PR
What this PR does / why we need it
I simply updated the template docstring.
Although this PR may not seem important, it could have a significant effect of encouraging the authors to write a proper docstring; The original docstrings, e.g.
"""Base Class for all Generators""", are not clearly stating that they originate from the template. In constrast, the new docstring clearly conveys the message"""TODO: Copy and edit this template to implement your own validator class""".Special notes for your reviewer
If applicable**