present: document shebang and txtar for .play#588
Open
oxzi wants to merge 1 commit intogolang:masterfrom
Open
Conversation
Contributor
|
This PR (HEAD: 7f76053) has been imported to Gerrit for code review. Please visit Gerrit at https://go-review.googlesource.com/c/tools/+/695356. Important tips:
|
7f76053 to
3dcbeb7
Compare
Contributor
|
Message from Gopher Robot: Patch Set 1: (1 comment) Please don’t reply on this GitHub thread. Visit golang.org/cl/695356. |
Contributor
|
This PR (HEAD: 3dcbeb7) has been imported to Gerrit for code review. Please visit Gerrit at https://go-review.googlesource.com/c/tools/+/695356. Important tips:
|
The "play" command for present does not only support Go code, which was implicitly documented, but also generic scripts identified by a shebang or txtar-encoded input - enabling Go modules. The locally used implementation for "play" resides in ./playground/socket/socket.go. Mostly undocumented, this code first checks the input for a shebang and, if present, executes input with the shebang interpreter. This code also allows txtar-encoded input, which can be used to "play" Go modules, including external dependencies. Documenting the actual behavior helps users to understand and use the software better. Personally, I initially wanted to patch Go module support in present, just to find out everything is already there - just undocumented.
3dcbeb7 to
10dcaf4
Compare
Contributor
|
This PR (HEAD: 10dcaf4) has been imported to Gerrit for code review. Please visit Gerrit at https://go-review.googlesource.com/c/tools/+/695356. Important tips:
|
This file contains hidden or 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
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.
The "play" command for present does not only support Go code, which was
implicitly documented, but also generic scripts identified by a shebang
or txtar-encoded input - enabling Go modules.
The locally used implementation for "play" resides in
./playground/socket/socket.go. Mostly undocumented, this code first
checks the input for a shebang and, if present, executes input with the
shebang interpreter. This code also allows txtar-encoded input, which
can be used to "play" Go modules, including external dependencies.
Documenting the actual behavior helps users to understand and use the
software better. Personally, I initially wanted to patch Go module
support in present, just to find out everything is already there - just
undocumented.