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

Azure Core linter rules docs and cleanup - Pass 1 #1357

Merged

Conversation

timotheeguerin
Copy link
Member

@timotheeguerin timotheeguerin commented Aug 12, 2024

Going through the Azure core linter rule and adding docs + cleaning up

  • use-standard-operations: Add docs for linter rule and cleanup a lot of things not needed since we moved to the linter system
  • spread-discriminated-model: Add docs
  • prevent-format: Add docs and cleanup
  • no-nullable: Add Docs

@azure-sdk
Copy link
Collaborator

azure-sdk commented Aug 12, 2024

All changed packages have been documented.

  • @azure-tools/typespec-azure-core
  • @azure-tools/typespec-azure-resource-manager
  • @azure-tools/typespec-azure-rulesets
Show changes

@azure-tools/typespec-azure-core - internal ✏️

Cleanup and docs linter rules

@azure-tools/typespec-azure-resource-manager - internal ✏️

Cleanup and docs linter rules

@azure-tools/typespec-azure-rulesets - fix ✏️

Disable use-standard-operations azure core linter rule from resource-manager ruleset

@azure-sdk
Copy link
Collaborator

You can try these changes here

🛝 Playground 🌐 Website 📚 Next docs

@timotheeguerin timotheeguerin changed the title Cleanup and docs linter rules Azure Core linter rules docs and cleanup - Pass 1 Aug 12, 2024
Copy link
Member

@markcowl markcowl left a comment

Choose a reason for hiding this comment

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

Always nice when you can remove code labeled with 'hack, hack, hack'

@timotheeguerin timotheeguerin added this pull request to the merge queue Aug 29, 2024
Merged via the queue into Azure:main with commit d55c5ee Aug 29, 2024
22 checks passed
@timotheeguerin timotheeguerin deleted the cleanup-and-docs-linter-rules branch August 29, 2024 18:38
markcowl added a commit to markcowl/typespec-azure that referenced this pull request Sep 7, 2024
Going through the Azure core linter rule and adding docs + cleaning up 

- `use-standard-operations`: Add docs for linter rule and cleanup a lot
of things not needed since we moved to the linter system
- `spread-discriminated-model`: Add docs
- `prevent-format`: Add docs and cleanup
- `no-nullable`: Add Docs

---------

Co-authored-by: Mark Cowlishaw <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants