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

Move processing docstring warnings to logs #9177

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

a-sido
Copy link

@a-sido a-sido commented Dec 30, 2024

Issue #, if available: #8455

Description of changes:
Help pages shouldn't show non-critical processing docstring warnings for end users, but it will be useful to keep them in logs. This PR proposes capture warnings in warning_stream during docstring processing and LOG them as warnings.

Contains also minor auto-lint fixes.

Tested locally on macos (m1):

❯ aws apprunner disassociate-custom-domain help > /dev/null
❯ echo $?
0
❯ aws apprunner disassociate-custom-domain help --debug > /dev/null
...
2024-12-30 12:36:03,501 - MainThread - awscli.help - WARNING - Warnings processing docstring with docutils: <string>:268: (WARNING/2) Inline literal start-string without end-string.
2024-12-30 12:36:03,501 - MainThread - awscli.help - DEBUG - Running command: ['groff', '-m', 'man', '-T', 'ascii']
2024-12-30 12:36:03,526 - MainThread - awscli.help - DEBUG - Running command: ['less', '-R']
...

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

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.

1 participant