doc: markdown improvements in build_osx.md #17016

pull RandyMcMillan wants to merge 0 commits into bitcoin:master from RandyMcMillan:doc-build-osx-md changing 0 files +0 −0

RandyMcMillan commented at 4:09 AM on October 2, 2019: contributor

modified: doc/build-osx.md

The tags were not displaying correctly. These changes ensure the commands that they wrap are displayed correctly and that the user can easily copy and paste them. The issue isn't obvious when viewing the markdown on GitHub.com
fanquake added the label Docs on Oct 2, 2019
in doc/build-osx.md:38 in 4d09b7d25f outdated
```
  37 | @@ -35,7 +38,7 @@ you can use [this](/contrib/install_db4.sh) script to install it
  38 |  like so:
  39 |  
  40 |  ```shell
  41 | -./contrib/install_db4.sh .
```
fanquake commented at 4:32 AM on October 2, 2019:

The . is part of the command, it shouldn't be removed.

RandyMcMillan commented at 4:59 PM on October 2, 2019:

It will be corrected in a future PR. I will try to articulate the issue better below.

fanquake commented at 4:38 AM on October 2, 2019: member

Where are the docs not displaying correctly?

Travis has failed because of:

This diff appears to have added new lines with trailing whitespace.
The following changes were suspected:
diff --git a/doc/build-osx.md b/doc/build-osx.md
@@ -47,0 +51 @@ from the root of the repository.
+
@@ -57,0 +62 @@ from the root of the repository.
+

Once you've fixed any issues, please squash your commits and use a commit message like doc: fix markdown display in build-osx.md.

laanwj renamed this:
~~doc: markdown not displaying correctly~~
doc: markdown improvements in build_osx.md
on Oct 2, 2019
laanwj commented at 9:48 AM on October 2, 2019: member

Where are the docs not displaying correctly?

I'd also like to know this. Is there any other software that formats the markdown for display, besides github itself?
in doc/build-osx.md:104 in 4d09b7d25f outdated
```
 101 | +```
 102 | +```shell
 103 |  touch "/Users/${USER}/Library/Application Support/Bitcoin/bitcoin.conf"
 104 | -
 105 | +```
 106 | +```shell
```
MarcoFalke commented at 12:35 PM on October 2, 2019:

why are these split?

RandyMcMillan commented at 5:10 PM on October 2, 2019:

The underlying issue is related to: https://help.github.com/en/articles/creating-and-highlighting-code-blocks#fenced-code-blocks

The syntax highlighting isn't standard markdown. This is creating an inconsistency with markdown interpreters. The GitHub interpreter seems to correct this (probably because the error is very common).

I will be happy to correct them because it isn't isolated to this one file.
RandyMcMillan closed this on Oct 2, 2019
MarcoFalke locked this on Dec 16, 2021

Contributors

Labels