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.

Sign up for GitHub

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

Jump to bottom

Extra text appended to doc for for ssl_create_unverified_context #354

Closed
ericwb opened this issue Mar 15, 2024 · 0 comments · Fixed by #716
Closed

Extra text appended to doc for for ssl_create_unverified_context #354

ericwb opened this issue Mar 15, 2024 · 0 comments · Fixed by #716
Labels
bug Something isn't working

Comments

@ericwb
Copy link
Contributor

ericwb commented Mar 15, 2024

Describe the bug
Extra text appended to doc for for ssl_create_unverified_context

To Reproduce

  1. https://precli.readthedocs.io/latest/rules/python/stdlib/ssl_create_unverified_context/
  2. Notice the documentation includes extra after the "New in version" line
  3. It is picking up the analyze function's docstring, which wasn't meant to be a docstring.

Expected behavior
Should not appear

Version
n/a

Additional context
n/a
@ericwb ericwb added the bug Something isn't working label Mar 15, 2024
ericwb added a commit to ericwb/precli that referenced this issue Jan 8, 2025
@ericwb
Remove extra text ended up in doc for rule
9ba7ca7 
The ssl_create_unverified_context rule documentation gets
extra text as it interprets some of the docstring in the
analyze_call function as doc text.

This change will just remove the reference docstring helper
text.

Fixes securesauce#354

Signed-off-by: Eric Brown <[email protected]>
@ericwb ericwb mentioned this issue Jan 8, 2025
Merged
@ericwb ericwb closed this as completed in 532165d Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Remove extra text ended up in doc for rule ericwb/precli
1 participant
@ericwb