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

Update the order of remarks and examples to align with docs.ms #3386

Merged
merged 3 commits into from
Jun 14, 2022

Conversation

sima-zhu
Copy link
Contributor

@sima-zhu sima-zhu commented May 27, 2022

We have different definition for the order of <remarks> and <examples>.
Update our template to align with mdoc.

Link

In github io:
image

In Docs.ms:
image

@sima-zhu sima-zhu marked this pull request as ready for review May 27, 2022 18:22
@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

@benbp
Copy link
Member

benbp commented Jun 1, 2022

I know this is mostly keeping parity with upstream changes, but a screenshot might be helpful representing the change.

@weshaggard
Copy link
Member

@sima-zhu lets wait until after releases to merge this as it isn't very important and we want to avoid any issues with release week.

@ghost
Copy link

ghost commented Jun 14, 2022

Hello @azure-sdk!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

@ghost
Copy link

ghost commented Jun 14, 2022

Apologies, I am afraid I am encountering technical difficulties that might have hampered my ability to assist with merging this pull request. I will continue to try to assist if there are further changes to this pull request.

@sima-zhu
Copy link
Contributor Author

/check-enforcer override

@sima-zhu sima-zhu merged commit b3675ef into Azure:main Jun 14, 2022
@sima-zhu sima-zhu deleted the update_order branch June 14, 2022 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Central-EngSys This issue is owned by the Engineering System team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants