Add resource documentation #16
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
This adds documentation for resource shapes. It also updates service docs do include resource and operation listings, which is mostly shared logic with resources. This also adds some missing instability decoratos to sections.
This updates the shape types printed for members that target unlinkable shape to simply be the shape type name. This should be much more clear.
JordonPhillips
force-pushed
the
resources
branch
from
2170a5d to
ce6121a
Compare
kstich
reviewed
Nov 9, 2023
| @@ -92,6 +93,6 @@ public void generateIntEnumShape(GenerateIntEnumDirective<DocGenerationContext, | |||
|
|
|||
| @Override | |||
| public void generateResource(GenerateResourceDirective<DocGenerationContext, DocSettings> directive) { | |||
| // no-op for now | |||
| new ResourceGenerator().accept(directive.context(), directive.shape()); | |||
There was a problem hiding this comment.
Why a different creation pattern than the other directives?
There was a problem hiding this comment.
Rather than passing along the entire directive you mean? Because the directive doesn't have anything else that's needed. It doesn't for the other generators either, I just haven't got around to refactoring them yet.
kstich
approved these changes
Nov 13, 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.
This adds documentation for resource shapes and adds operation/resource documentation to service shapes.
A few bits of cleanup were done as well. The
ServiceShapeSectionandServiceDetailsSectionwere removed in favor of using the generic equivalents. Additionally, several internal/unstable classes had their relevant missing decorators set. A few minor inconsistencies on when sections would be emitted were also resolved.Lastly, the way shape names are emitted for shapes that don't have their own documentation sections was changed. In those cases the shape type is now emitted instead. This makes it way more clear what the shape's actual type is since there's no way to click through to find it. This change was made in such a way that if definition sections are added for those shapes, they'll automatically get updated reference them directly again.
Screenshots below, and as always a full build is available from the CI run.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.