Improved docs #21
Merged
Improved docs #21
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
shumbo
reviewed
Oct 5, 2023
chorus_book/src/guide-locations.md
Outdated
|
|
||
| ## Location Set | ||
|
|
||
| Each Choreography is allowed to operate on a set of `ChoreographyLocation`, called its `LocationSet`. You can use the macro `LocationSet!` and give it a comma separated list of `ChoreographyLocation` to build a `LocationSet`. |
There was a problem hiding this comment.
I wonder if we need to mention "choreography" here as the readers don't know what it is at this point. Can we just explain what a location set is without talking about choreography or projector?
shumbo
reviewed
Oct 6, 2023
Co-authored-by: Shun Kashiwa <[email protected]>
shumbo
approved these changes
Oct 6, 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 pull request improves the documentation:
LocationSetis now first introduced in theLocationsection instead ofChoreography. Also, the documentation on building a customTransportis improved.