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

[Storage] Updated credentials formatting in docstrings and disabled docstring-keyword-should-match-keyword-only #35296

Conversation

weirongw23-msft
Copy link
Member

@weirongw23-msft weirongw23-msft commented Apr 21, 2024

This PR will enable all five packages to run properly in CI. In particular, we provided linting updates for pylint version 3.0.3. The build is passing locally after resolving all errors and running the appropriate next-pylint tox commands at the library package-level. Here are the links to the Github Issues:

The updates here include:

  1. Disabling docstring-keyword-should-match-keyword-only in each file across every package that generated an error in the original tox run. Also reformatted the files to ensure the # pylint: disable=... have a newline between the disable comment and import statements, as well as consolidated file-wide pylint disable comments.
  2. Updated the packages to ensure credential parameter is formatted consistently as discussed.

Note that docstring-keyword-should-match-keyword-only is a temporary fix, because moving all existing keywords to named keywords and fully documenting them will take significant engineering effort. We're currently working on resolving that.

@github-actions github-actions bot added the Storage Storage Service (Queues, Blobs, Files) label Apr 21, 2024
@azure-sdk
Copy link
Collaborator

API change check

API changes are not detected in this pull request.

Copy link
Member

@vincenttran-msft vincenttran-msft left a comment

Choose a reason for hiding this comment

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

Thanks for getting to this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Storage Storage Service (Queues, Blobs, Files)
Projects
None yet
3 participants