Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding documentation to CWE-617 as part of #531 #651

Merged
merged 2 commits into from
Oct 16, 2024

Conversation

s19110
Copy link
Contributor

@s19110 s19110 commented Oct 10, 2024

Adding documentation to CWE-617 as part of #531

Copy link
Contributor

@myteron myteron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

only cosmetics, approved otherwise.


## Non-Compliant Code Example

The code is checking for invalid arguments by using assertions. In this example, any positive integer between 1-709 inclusive is valid, and any other argument is invalid.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cosmetics: 1-709


|||
|:---|:---|
|[[Python 3.9 Documentation](https://docs.python.org/3.9/using/cmdline.html?highlight=pythonoptimize#cmdoption-o)]|Python Software Foundation. (2024). Command line and environment - cmdoption -o [online].<br>Available from: [https://docs.python.org/3.9/using/cmdline.html?highlight=pythonoptimize#cmdoption-o](https://docs.python.org/3.9/using/cmdline.html?highlight=pythonoptimize#cmdoption-o)<br>[accessed 10 October 2024].|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cosmetics: first link should be to main docs.python.org/3.9

@myteron
Copy link
Contributor

myteron commented Oct 16, 2024

got +1 from bart as well, merging this in

@myteron myteron merged commit 8b675cc into ossf:main Oct 16, 2024
2 checks passed
@s19110 s19110 deleted the pyDoc2GitHub_CWE-617 branch October 16, 2024 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants