Diplomacy Tutorial: make it clear how to execute it #2664
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
debs-sifive
approved these changes
Oct 13, 2020
There was a problem hiding this comment.
Not sure if you think this is a useful idea... But what if we put an invisible code block at the top of the tutorial with a comment like
/** ATTENTION: if you can read this, you are reading raw documentation. Please generate
* documentation from this source file as described in the docs/README.md.
*/
So then if someone stumbles across the source docs, they know they are reading the wrong thing? I was super confused by generated versus raw docs in our private repo.
| call it with `sbt`: | ||
|
|
||
| ``` scala mdoc:silent | ||
| /** MAIN */ |
There was a problem hiding this comment.
Can probably take out this comment b/c it doesn't add much.
There was a problem hiding this comment.
(Referring to /**MAIN*/)
|
I was JUST thinking that we should put a comment like that... as I was reading the source and confused by the printf at the end |
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.
Add more instructions to the Diplomacy tutorial that make it more "doing" vs "reading". Needed to clarify both how to build the docs or how to copy-and-paste and execute the code by making another main.
Related issue:
Type of change: other enhancement
Impact: no functional change
Development Phase: implementation
Release Notes