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

Setup strict phinx mode, fixed all phinx warnings #34960

Closed
wants to merge 19 commits into from
Closed

Setup strict phinx mode, fixed all phinx warnings #34960

wants to merge 19 commits into from

Conversation

jakublehotsky
Copy link

Description

This patch fixes the warnings generated by sphinx python docstring tool when run in strict mode. It fixes the automatically generated documentation in a couple of places, removing obsolete anchors to samples and fixing links and dedent for linked samples for sync and sync version of communication client.

It also introduces the default sphinx = true option as requested in the original issue.

closes #33567

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@azure-sdk
Copy link
Collaborator

API change check

API changes are not detected in this pull request.

@github-actions GitHub Actions
Copy link

Hi @jakublehotsky. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

@github-actions github-actions bot added the no-recent-activity There has been no recent activity on this issue. label May 31, 2024
@jakublehotsky
Copy link
Author

Trying to identify a reason for failing a single unit test on ubuntu where it throws in timer which doesn't seem related with my changes at all.

@github-actions GitHub Actions
Copy link

Hi @jakublehotsky. Thank you for your contribution. Since there hasn't been recent engagement, we're going to close this out. Feel free to respond with a comment containing /reopen if you'd like to continue working on these changes. Please be sure to use the command to reopen or remove the no-recent-activity label; otherwise, this is likely to be closed again with the next cleanup pass.

@github-actions github-actions bot closed this Jun 12, 2024
@jakublehotsky
Copy link
Author

/reopen
The issue is not fixed yet

@jakublehotsky jakublehotsky reopened this Jun 13, 2024
@github-actions github-actions bot removed the no-recent-activity There has been no recent activity on this issue. label Jun 13, 2024
azure-sdk and others added 11 commits June 13, 2024 09:09
@azure-sdk
Increment package version after release of azure-eventgrid (#36063)
3ce8196
@azure-sdk @JimSuplizio
Sync eng/common directory with azure-sdk-tools for PR 8388 (#35970)
66d5de4 
* Removal of the devops release PAT

* Don't pass in the access token, just use the AzureCLI task and do everything in the scripts

* Updates for feedback

---------

Co-authored-by: James Suplizio <[email protected]>
@catalinaperalta @cperaltah
report number of breaking changes (#36067)
15bcb99 
Co-authored-by: Catalina Peralta <[email protected]>
@xiangyan99
update codeowner (#36074)
0f27374 
* update codeowner

* update
@kristapratico
update strict-sphinx to v7 (#36075)
d7bfdb0
@azure-sdk @jeremymeng
Update spelling dependencies (#36084)
df9c8c7 
This is the result of `npm audit fix` to address vulnerability in older versions
of `braces`.

Co-authored-by: Jeremy Meng <[email protected]>
@drielenr
[DevCenter] Update release date (#36083)
3e7dff6 
* Update release date

* Add codeowners to dev center

* Update to github alias

* Fix label name
@pvaneck
[Identity] Add TSG section for AzurePipelinesCredential (#36048)
147746b 
Signed-off-by: Paul Van Eck <[email protected]>
@dargilco
Support sending image data as part of a user message, using a new Ima…
c19f701 
…geUrl.load() method. Add sample and test. (#36042)
@jakublehotsky
Strict phinx mode, fixed all phinx warnings
afa3b17
@jakublehotsky
Merge branch 'python-docstring-warnings-fix' of https://github.com/Az…
b297199 
…ure/azure-sdk-for-python into python-docstring-warnings-fix
@jakublehotsky jakublehotsky requested review from a team, scbedd, weshaggard and benbp as code owners June 14, 2024 08:31
@jakublehotsky
Copy link
Author

This issue was resolved by #36111

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mjafferi-msft mjafferi-msft mjafferi-msft approved these changes

@AikoBB AikoBB Awaiting requested review from AikoBB AikoBB is a code owner

@maximrytych-ms maximrytych-ms Awaiting requested review from maximrytych-ms maximrytych-ms is a code owner

@scbedd scbedd Awaiting requested review from scbedd scbedd is a code owner

@weshaggard weshaggard Awaiting requested review from weshaggard weshaggard is a code owner

@benbp benbp Awaiting requested review from benbp benbp is a code owner

@dargilco dargilco Awaiting requested review from dargilco dargilco is a code owner

@kashifkhan kashifkhan Awaiting requested review from kashifkhan kashifkhan is a code owner

@l0lawrence l0lawrence Awaiting requested review from l0lawrence l0lawrence is a code owner

@drielenr drielenr Awaiting requested review from drielenr drielenr is a code owner

@leti367 leti367 Awaiting requested review from leti367

@sebrenna sebrenna Awaiting requested review from sebrenna sebrenna is a code owner

@pvaneck pvaneck Awaiting requested review from pvaneck pvaneck is a code owner

@xiangyan99 xiangyan99 Awaiting requested review from xiangyan99 xiangyan99 is a code owner

@maorleger maorleger Awaiting requested review from maorleger maorleger is a code owner automatically assigned from Azure/azure-sdk-write-identity

@billwert billwert Awaiting requested review from billwert billwert is a code owner automatically assigned from Azure/azure-sdk-write-identity

@ahsonkhan ahsonkhan Awaiting requested review from ahsonkhan ahsonkhan is a code owner automatically assigned from Azure/azure-sdk-write-identity

@KarishmaGhiya KarishmaGhiya Awaiting requested review from KarishmaGhiya KarishmaGhiya is a code owner automatically assigned from Azure/azure-sdk-write-identity

@schaabs schaabs Awaiting requested review from schaabs schaabs is a code owner automatically assigned from Azure/azure-sdk-write-identity

@gfeitosa-msft gfeitosa-msft Awaiting requested review from gfeitosa-msft gfeitosa-msft is a code owner

@besh2014 besh2014 Awaiting requested review from besh2014 besh2014 is a code owner

@phermanov-msft phermanov-msft Awaiting requested review from phermanov-msft phermanov-msft is a code owner

@ilyapaliakou-msft ilyapaliakou-msft Awaiting requested review from ilyapaliakou-msft ilyapaliakou-msft is a code owner

@miguhern miguhern Awaiting requested review from miguhern miguhern is a code owner

@whisper6284 whisper6284 Awaiting requested review from whisper6284 whisper6284 is a code owner

@RoyHerrod RoyHerrod Awaiting requested review from RoyHerrod

@danielav7 danielav7 Awaiting requested review from danielav7 danielav7 is a code owner

@sarkar-rajarshi sarkar-rajarshi Awaiting requested review from sarkar-rajarshi sarkar-rajarshi is a code owner

Assignees
No one assigned
Labels
Communication - Identity
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

azure-communication-identity needs docstring updates for sphinx
9 participants
@jakublehotsky @azure-sdk @mjafferi-msft @catalinaperalta @xiangyan99 @kristapratico @drielenr @pvaneck @dargilco