Prevent creation of .md-e
files in the docs
#3799
Merged
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.
Description
Currently the pre-commit lint step uses
sed
to ensure that we do not use```console
in the documentation and instead replace it with```bash
.The
sed
command works for Linux but is interpreted differently on macOS where-i -e
is interpreted as-i='-e'
and causes.md-e
files to to be created for every documentation file when linting usingjust lint
. Usingperl
can avoid this problem as that approach is cross-platform (providedperl
is installed, which is usually is).This also updates another script that used a similar construct in a different script (with the working and broken operating systems reversed) with
perl
.Testing Instructions
```bash
to```console
in the docs.Checklist
Update index.md
).main
) or a parent feature branch.Developer Certificate of Origin
Developer Certificate of Origin