[SPARK-28473][DOC] Stylistic consistency of build command in README #25231
Conversation
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
dongjoon-hyun
changed the title
| To build Spark and its example programs, run: | ||
|
|
||
| build/mvn -DskipTests clean package | ||
| ./build/mvn -DskipTests clean package |
Member
There was a problem hiding this comment.
Could you find more instances, @Mister-Meeseeks ? For example, R/README.md also has this.
To enforce stylistic consistency and increase clarity for the user, shell
command examples in the docs were prepended with `./`. For example
bin/spark-submit --jars ...
becomes
./bin/spark-submit --jars ...
This is the convention adhered to for most of the documentation already. This
commit converts the minority of examples that don't.
The `./` prefix is only added in the context of a specific instructional
command. When the docs are discussing in the context of a script, the prefix
is not included. For example "the `bin/spark-submit` script is used to launch
jobs" would *not* require the `./` prefix.
Contributor
Author
|
I scoured the documentation for offending examples. I believe I found and corrected every command example not conforming to the |
srowen
reviewed
Jul 23, 2019
Member
srowen
left a comment
srowen
left a comment
There was a problem hiding this comment.
Looks good if we can fix all of them consistently
Member
|
ok to test. |
|
Test build #108061 has finished for PR 25231 at commit
|
dongjoon-hyun
approved these changes
Jul 23, 2019
Member
dongjoon-hyun
left a comment
dongjoon-hyun
left a comment
There was a problem hiding this comment.
+1, LGTM.
Thank you, @Mister-Meeseeks and @srowen .
Merged to master.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
What changes were proposed in this pull request?
Change the format of the build command in the README to start with a
./prefixThis increases stylistic consistency across the README- all the other commands have a
./prefix. Having a visible./prefix also makes it clear to the user that the shell command requires the current working directory to be at the repository root.How was this patch tested?
README.md was reviewed both in raw markdown and in the Github rendered landing page for stylistic consistency.