Add documentation for forbidden-io-functions option of forbidden_io_function_checker #947
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
Pull Request Test Coverage Report for Build 6241107158
💛 - Coveralls |
There was a problem hiding this comment.
@vsahni3 great work. I left two inline comments. Additionally, please add your name to the list of contributors (at the bottom of the README).
docs/checkers/index.md
Outdated
| @@ -2131,6 +2131,17 @@ if __name__ == "__main__": | |||
| name = input() | |||
| ``` | |||
|
|
|||
| By default, [`input`], [`open`] and [`print`] are not allowed. However, you can choose which I/O functions specifically to disallow using the forbidden-io-functions | |||
There was a problem hiding this comment.
Write the option name forbidden-io-functions inside backticks (`) so that it appears in code font.
docs/checkers/index.md
Outdated
| @@ -2131,6 +2131,17 @@ if __name__ == "__main__": | |||
| name = input() | |||
| ``` | |||
|
|
|||
| By default, [`input`], [`open`] and [`print`] are not allowed. However, you can choose which I/O functions specifically to disallow using the forbidden-io-functions | |||
| option. This takes a list of built-in function names that should not be used. For example, | |||
There was a problem hiding this comment.
Remove the word "built-in". (The functions could be from anywhere.)
david-yz-liu
approved these changes
Sep 20, 2023
|
Great work @vsahni3! |
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.
Motivation and Context
There is currently no documentation for the forbidden-io-functions configuration option of the forbidden_io_function_checker. This can make it difficult for users to know about its existence, how to use it, and what additional flexibility it offers.
Your Changes
This pull request adds documentation for the above configuration option detailing its purpose, how to use it, and what it should be used for.
Type of change (select all that apply):
Testing
To ensure the documentation is readable and well-formatted, I built the documentation website to see how the users would view it and made sure everything was as expected.
Checklist