Skip to content
This repository has been archived by the owner on Oct 8, 2020. It is now read-only.

Commit

Permalink
Update style-guide.md
Browse files Browse the repository at this point in the history
  • Loading branch information
homotechsual authored Jun 6, 2020
1 parent 8299124 commit d4c8866
Showing 1 changed file with 1 addition and 19 deletions.
20 changes: 1 addition & 19 deletions docs/documentation/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,25 +242,7 @@ them in the right direction when they want to know about those tasks.

### Shell Commands in documentation.

When writing shell commands in documentation as examples, for any commands that are expected to be typed out by the user a `$` should be put in front of the command. e.g.

```shell
$ cd ~/buildkit/build/drupal-demo/sites/all/modules/civicrm
$ civibuild create drupal-demo --civi-ver master --url http://localhost:8001
$ hub fork
```

The output of a shell command should not have a `$` prepended. e.g.

```shell
$ git remote -v
origin https://github.com/civicrm/civicrm-core.git (fetch)
origin https://github.com/civicrm/civicrm-core.git (push)
yourusername git@github.com:yourusername/civicrm-core.git (fetch)
yourusername git@github.com:yourusername/civicrm-core.git (push)
```

Authors should also not put any comments within the examples themselves, whereas any comments should go outside of the code block in regular paragraphs. Where possible each command should be its own comment block. When it is crucial for the user to understand the directory in which to run the command, include a separate code block before hand with a `cd` command.
Authors should not put any comments within code examples, any comments should go outside of the code block in regular paragraphs. Where possible each command should be its own block. When it is crucial for the user to understand the directory in which to run the command, include a separate code block before hand with a `cd` command.

!!! tip "Write portable shell commands"

Expand Down

0 comments on commit d4c8866

Please sign in to comment.