Update API Documentation: Change Parameter Type from "string" to "str" in Comments for Python Consistency #460
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
In the class "State": In the comments, change "string" to "str" so that the parameter type is linked to the python docs in the API documentation.
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.
Provide a summary of the proposed changes, describe tests and documentation, and review the acknowledgement below.
Summary
This pull request addresses an update to the API documentation in the fragility_curve.py file. Specifically, the data type annotation for the name parameter was updated from "string" to "str" to provide a direct link to Python documentation, improving usability and clarity.
Tests and documentation
This change impacts only the documentation and does not modify the functionality of the code. Therefore, no additional tests are required.
Acknowledgement
By contributing to this software project, I acknowledge that I have reviewed the software quality assurance guidelines and that my contributions are submitted under the Revised BSD License.