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

Update READMEs. #14501

Merged
merged 2 commits into from
Jun 8, 2021
Merged

Update READMEs. #14501

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0fa1d14
Readme Updates
tjprescott May 20, 2021
b2da280
Code review feedback.
tjprescott Jun 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions specification/cognitiveservices/data-plane/ComputerVision/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ directive:
These settings apply only when `--python` is specified on the command line.
Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`.
Use `--python-mode=update` if you already have a setup.py and just want to update the code itself.
May need to supply `--version=V2` on the command line.

``` yaml $(python)
python-mode: create
Expand All @@ -133,6 +134,7 @@ add-credentials: true
payload-flattening-threshold: 2
namespace: azure.cognitiveservices.vision.computervision
package-name: azure-cognitiveservices-vision-computervision
package-version: 0.9.0
clear-output-folder: true
use: "@microsoft.azure/autorest.python@~4.0.71"
version: V2
Expand Down
6 changes: 3 additions & 3 deletions specification/cognitiveservices/data-plane/Personalizer/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

> see https://aka.ms/autorest

The current release is `release_1_0`. A preview release release_1_0 is also available
The current release is `release_1_0`. A preview release release_1_1_preview.1 is also available

``` yaml
tag: release_1_0
tag: release_1_1_preview.1
add-credentials: true
openapi-type: data-plane
```
Expand All @@ -28,7 +28,7 @@ input-file:
- preview/v1.0/Personalizer.json
```

### Release 1.0-Preview
### Release 1.1-Preview
These settings apply only when `--tag=release_1_1_preview.1` is specified on the command line.

``` yaml $(tag) == 'release_1_1_preview.1'
Expand Down
33 changes: 19 additions & 14 deletions specification/cognitiveservices/data-plane/Personalizer/readme.python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,29 @@
These settings apply only when `--python` is specified on the command line.
Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`.
Use `--python-mode=update` if you already have a setup.py and just want to update the code itself.
When used on the command line, you may need to specify `--verison=V2`.

use: "@microsoft.azure/autorest.python@~4.0.71"
tjprescott marked this conversation as resolved.
Show resolved Hide resolved
version: V2
multiapi: true
no-async: true


``` yaml $(python)
python-mode: create
python:
license-header: MICROSOFT_MIT_NO_VERSION
add-credentials: true
payload-flattening-threshold: 2
namespace: azure.cognitiveservices.personalizer
package-name: azure-cognitiveservices-personalizer
clear-output-folder: true
package-version: 0.2.0
license-header: MICROSOFT_MIT_NO_VERSION
add-credentials: true
payload-flattening-threshold: 2
namespace: azure.cognitiveservices.personalizer
package-name: azure-cognitiveservices-personalizer
```
``` yaml $(python) && $(python-mode) == 'update'
python:
no-namespace-folders: true
output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-personalizer/azure/cognitiveservices/personalizer
no-namespace-folders: true
clear-output-folder: false
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: since false is default for clear-output-folder, you can just remove this line

Copy link
Member Author

Choose a reason for hiding this comment

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

I have run into situations where the default wasn't the default on older versions of autorest, so I think there's some value in being explicit here.

output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-personalizer/azure/cognitiveservices/personalizer
```
``` yaml $(python) && $(python-mode) == 'create'
python:
basic-setup-py: true
output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-personalizer
basic-setup-py: true
clear-output-folder: true
output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-personalizer
```
30 changes: 15 additions & 15 deletions specification/servicefabric/data-plane/readme.python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,23 @@ Please also specify `--python-sdks-folder=<path to the root directory of your az
Use `--python-mode=update` if you already have a setup.py and just want to update the code itself.

``` yaml $(python)
python-mode: create
python:
license-header: MICROSOFT_MIT_NO_VERSION
payload-flattening-threshold: 2
namespace: azure.servicefabric
package-name: azure-servicefabric
package-version: 8.0.0.0
add-credentials: true
clear-output-folder: true
license-header: MICROSOFT_MIT_NO_VERSION
payload-flattening-threshold: 2
namespace: azure.servicefabric
package-name: azure-servicefabric
package-version: 8.0.0.0
add-credentials: true
clear-output-folder: true
use: "@microsoft.azure/autorest.python@~4.0.71"
version: V2
multiapi: true
no-async: true
```
``` yaml $(python) && $(python-mode) == 'update'
python:
no-namespace-folders: true
output-folder: $(python-sdks-folder)/servicefabric/azure-servicefabric/azure/servicefabric
no-namespace-folders: true
output-folder: $(python-sdks-folder)/servicefabric/azure-servicefabric/azure/servicefabric
```
``` yaml $(python) && $(python-mode) == 'create'
python:
basic-setup-py: true
output-folder: $(python-sdks-folder)/servicefabric/azure-servicefabric
basic-setup-py: true
output-folder: $(python-sdks-folder)/servicefabric/azure-servicefabric
```