[docs-sync] Update documentation for recent code changes#46
Draft
github-actions[bot] wants to merge 1 commit into
Draft
[docs-sync] Update documentation for recent code changes#46github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
- Add csharp-no-url-suffix linter rule documentation (added in commit aac448e 'Add no-url-suffix linter rule') - Add client-sdk ruleset to typespec-azure-rulesets linter reference (added in commit aac448e) - Update ARM library reference docs for decorators, interfaces, and data types (added in commit 364b924 'Improve documentation for ARM library decorators, interfaces, and models') Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR syncs the documentation with recent code changes merged to
mainin the past 7 days.Changes
1. Add
csharp-no-url-suffixlinter rule documentationSource commit:
aac448e2— Add no-url-suffix linter rule (Azure#4541)New file:
website/src/content/docs/docs/libraries/typespec-client-generator-core/rules/csharp-no-url-suffix.mdDocuments the new
csharp-no-url-suffixlinter rule that flags model properties ending withUrland suggests usingUrisuffix to follow .NET SDK naming conventions.Updated:
website/src/content/docs/docs/libraries/typespec-client-generator-core/reference/linter.mdAdded the new rule to the Rules table.
2. Add
client-sdkruleset to typespec-azure-rulesets documentationSource commit:
aac448e2— Add no-url-suffix linter rule (Azure#4541)website/src/content/docs/docs/emitters/typespec-azure-rulesets/reference/linter.mdAdded
@azure-tools/typespec-azure-rulesets/client-sdkto the list of available RuleSets. This ruleset enables thecsharp-no-url-suffixrule.3. Update ARM library reference documentation
Source commit:
364b9245— Improve documentation for ARM library decorators, interfaces, and models (Azure#4494)Updated:
website/src/content/docs/docs/libraries/azure-resource-manager/reference/decorators.mdImproved descriptions for ARM decorator documentation including
@armResourceAction,@armResourceCreateOrUpdate,@armResourceRead,@armResourceUpdate,@armResourceDelete,@armResourceList,@armResourceCollectionAction, and others.Updated:
website/src/content/docs/docs/libraries/azure-resource-manager/reference/interfaces.mdFixed misleading documentation on
ResourceDeleteWithoutOkAsyncand improved other interface docs.Updated:
website/src/content/docs/docs/libraries/azure-resource-manager/reference/data-types.mdImproved docs for
ResourceListCustomResultand related types.