Add examples of validators to documentation #1702
Merged
Conversation
This file contains 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
haydenbaker
requested changes
Apr 5, 2023
haydenbaker
reviewed
Apr 7, 2023
haydenbaker
reviewed
Apr 7, 2023
haydenbaker
reviewed
Apr 7, 2023
haydenbaker
reviewed
Apr 7, 2023
haydenbaker
approved these changes
Apr 7, 2023
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.
Description of changes:
This pull request adds a number of example linters to as a subpage of the Validator page.
These examples are not exhaustive, but are intended to show users some of the ways smithy validators can prevent common bugs and enforce a common style in their Smithy models.
Testing
I checked each validator against a local model to make sure error messages formatted correctly and that they could be parsed. Then I generated the docs using the
make htmlcommand and visually checked the generated html.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.