Skip to content

Commit

Permalink
Fix broken links (#39126)
Browse files Browse the repository at this point in the history
  • Loading branch information
mccoyp authored Jan 18, 2025
1 parent df74f95 commit 5f70840
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion doc/dev/docstring.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ For adding a version specific change use the `versionadded` docstring:
```

Additional sphinx directives are documented [here](https://review.docs.microsoft.com/help/onboard/admin/reference/python/documenting-api?branch=master#supported-sphinx-directives)
Additional sphinx directives are documented [here](https://review.learn.microsoft.com/help/onboard/admin/reference/python/documenting-api#supported-sphinx-directives)

### Model and Client Docstrings

Expand Down
2 changes: 1 addition & 1 deletion doc/dev/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ C:\Users> python -m venv -p <path/to/Python/Python38/python.exe> py38_venv

In the root directory of our SDK, a number of mandatory files have been added. When creating your own SDK, these files can be copied from the [`sdk/template`](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/template) project, and modified to your needs.

- README.md. This is the description and guidance for customers or your SDK. Please see the guide on writing a README to make sure you have the complete [content requirements and formatting](https://review.docs.microsoft.com/help/contribute-ref/contribute-ref-how-to-document-sdk?branch=master#readme).
- README.md. This is the description and guidance for customers or your SDK. Please see the guide on writing a README to make sure you have the complete [content requirements and formatting](https://review.learn.microsoft.com/help/platform/reference-document-sdk-client-libraries#readme).
- CHANGELOG.md. This is where you will add the summary of changes for each new release. Please see [the guidance](https://azure.github.io/azure-sdk/policies_releases.html#changelog-guidance) for correct formatting.
- setup.py. This is the 'installer' for your Python SDK. Please see [the guide on Python packaging][packaging] for details on customizing this for a specific package.
- setup.cfg. This is an artifact used in building the Python package. Please see [the guide on Python packaging][packaging] for details.
Expand Down
2 changes: 1 addition & 1 deletion sdk/media/azure-media-analytics-edge/docs/DevTips.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ on how to install and run `tox`.

- Tox will complain if there are no tests. Add a dummy test in case you need to bypass this
- Make sure there is an `__init__.py` file inside of every directory inside of `azure` (Example: `azure/media` should have an __init__.py file)
- Follow the ReadMe guidelines outlined here: https://review.docs.microsoft.com/help/contribute-ref/contribute-ref-how-to-document-sdk?branch=master#readme. ReadMe titles are case SENSITIVE and use sentence casing.
- Follow the ReadMe guidelines outlined here: https://review.learn.microsoft.com/help/platform/reference-document-sdk-client-libraries#readme. ReadMe titles are case SENSITIVE and use sentence casing.
- Make sure MANIFEST.in includes all required folders. (Most likely the required folders will be tests, samples, and the generated folder)
2 changes: 1 addition & 1 deletion sdk/purview/azure-purview-sharing/samples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ page_type: sample
languages:
- python
products:
# Including relevant stubs from https://review.docs.microsoft.com/help/contribute/metadata-taxonomies#product
# Including relevant stubs from https://review.learn.microsoft.com/help/platform/metadata-taxonomies#product
- azure
name: Azure.Purview.Sharing samples for python
description: Samples for the Azure.Purview.Sharing client library.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ on how to install and run `tox`.

- Tox will complain if there are no tests. Add an empty test in case you need to bypass this
- Make sure there is an `__init__.py` file inside of every directory inside of `azure` (Example: `azure/media` should have an __init__.py file)
- Follow the ReadMe guidelines outlined here: https://review.docs.microsoft.com/help/contribute-ref/contribute-ref-how-to-document-sdk?branch=master#readme. ReadMe titles are case SENSITIVE and use sentence casing.
- Follow the ReadMe guidelines outlined here: https://review.learn.microsoft.com/help/platform/reference-document-sdk-client-libraries#readme. ReadMe titles are case SENSITIVE and use sentence casing.
- Make sure MANIFEST.in includes all required folders. (Most likely the required folders will be tests, samples, and the generated folder)

0 comments on commit 5f70840

Please sign in to comment.