Improve "Building Ruby" docs #12320
Improve "Building Ruby" docs #12320
Conversation
amomchilov
force-pushed
the
getting-started-docs
branch
2 times, most recently
from
659c86e to
8f2a4ee
Compare
NEWS.md
Outdated
| Old: | ||
| ``` | ||
| ```text |
There was a problem hiding this comment.
You seem to have mixed up doc improvements and the diff from #12322.
There was a problem hiding this comment.
Not mixed up, this PR is just stacked on top of those changes from #12322
There was a problem hiding this comment.
When you're "stacking" PRs, you usually point the stacked PR to the base branch you're stacking on (which doesn't work if you do that from a fork, so you have to give up in this case). What you're doing is filing PRs with duplicated changes to the same branch. Since you're actually not stacking PRs, you should rebase your branch and remove duplication.
As Stan said on Slack, your changes don't need to be stacked because markdown files don't have dependencies unlike code and these changes work correctly without each other.
|
Duplicated diffs require more effort to review and sometimes become a source of conflicts. If you're proposing a diff in other PRs, please remove it from this PR. |
amomchilov
force-pushed
the
getting-started-docs
branch
from
8f2a4ee to
d89b3f0
Compare
All the commands should run correctly by default, without the user needing to modify them. This builds confidence that the relative paths are working correct from within the `build` directory. Also, let’s use a consistent example throughout, for greater clarity.
This shows the correct way to combine `-v` with another parameter, e.g. a specific file to test.
amomchilov
force-pushed
the
getting-started-docs
branch
from
d89b3f0 to
7cd1807
Compare
3 participants
Currently, several of the commands listed in the "Testing Ruby" commands won't work, because they're expecting to run from the repository root (Example 1, 2, 3, 4). This contradicts the "Building Ruby" docs, which suggest building Ruby inside a
build/subdirectory. This PR corrects all those commands, to make them work from within thebuild/dir.This PR also makes several other improvements to the general clarity and readability of this documentation, especially for new readers. See the individual commits for more details.