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

Clarify doc about sources plugin #977

Merged
merged 1 commit into from
Feb 22, 2022
Merged

Clarify doc about sources plugin #977

merged 1 commit into from
Feb 22, 2022

Conversation

gosar
Copy link
Contributor

@gosar gosar commented Nov 11, 2021

  • All model names referenced by the manifest, may be confused with shape names. All model files seems clearer.
  • building a projection seems clearer than applying a projection. And matches the earlier sentence - When building the source projection.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@gosar gosar requested a review from a team as a code owner November 11, 2021 06:14
@gosar gosar changed the title Clarify doc about smithy manifest Clarify doc about sources plugin Nov 11, 2021
@@ -1446,14 +1446,14 @@ Smithy models contained within the JAR are copied as a source model while the
JAR itself is not copied. If there are no source models, an empty manifest is
created.

When applying a projection, a new model file is created that contains only
the shapes, trait definitions, and metadata that were defined in a source
When building a different projection, a new model file is created that contains
Copy link
Member

Choose a reason for hiding this comment

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

I don't see the reason for the word "different" here. Not sure what it means.

When applying a projection, a new model file is created that contains only
the shapes, trait definitions, and metadata that were defined in a source
When building a different projection, a new model file is created that contains
only the shapes, trait definitions, and metadata that were defined in a source
model *and* all of the newly added shapes, traits, and metadata.
Copy link
Member

Choose a reason for hiding this comment

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

Would be nice to clarify what "newly added" means here. I thought that was the main reason for the PR.

@gosar gosar merged commit b2911b2 into smithy-lang:main Feb 22, 2022
@gosar gosar deleted the doc-typo branch February 22, 2022 23:56
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.

2 participants