Skip to content

Commit ff3dace

Browse files
committed
improve writing
1 parent 65bf9fa commit ff3dace

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/src/devdocs/dev_guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ Catalyst release branch*.
3737
## Development advice
3838
3939
### Checking doc builds for errors
40-
When updating documentation, Catalyst will run any julia code provided within it to dynamically create figures and outputs. In addition to automatically creating these for us, it also provides an additional check that all code in documentation is correct. Here, if any of the documentation code throws an error, the build job will fail. The documentation build job can be found at the bottom of a PRs conversation, here is an example of a filed one:
40+
When updating documentation, Catalyst will run any Julia code provided within it to dynamically create figures and outputs. In addition to automatically creating these for us, it also provides an automatic check that all code in documentation is correct. Here, if any of the documentation code throws an error, the build job will fail. The documentation build job can be found at the bottom of a PRs conversation, here is an example of a failed one:
4141
![Failed builddocs link](../assets/failed_builddocs_link.png)
4242
To check what errors were produced, clock on the "Details" link of the job. Next, any errors can be found at the bottom of the "Build and deploy" section (which should be opened automatically).
4343
44-
### Inspecting documentation of a PR on branch
45-
When updating documentation it is typically useful to view the updated documentation in html format. Here, some errors are very easy to spot in html format, but difficult to do so in the raw text files from which these are generated. There are primarily to ways to view updated documentation, by downloading them from the PR or building the docs locally.
44+
### Inspecting documentation of a PR or branch
45+
When updating documentation it is typically useful to view the updated documentation in HTML format (which is the format users will see). Here, some errors are much easier to spot in html format as compared with the raw text files from which these are generated. There are two primary ways to view updated documentation, either by downloading them from the PR or by building the docs locally.
4646
4747
Whenever a PR to Catalyst is created, CI will create a corresponding documenter build job. If the build job passes, you can access the built documentation (which will be the new Catalyst documentation if the PR is merged) through the following steps:
4848
1. Click on "Details" in the documentation build job (at the bottom of the PR conversation tab).
@@ -55,4 +55,4 @@ To build the Catalyst documentation locally:
5555
2. Open the ".julia/dev/Catalyst/docs/build/index.html" file.
5656
5757
### Spellchecking in your code
58-
Especially when writing documentation, but also when writing normal code, it can be useful to have a spellchecker running through your texts. While code can be copied into a spellchecker and checked there, it can also be very useful to (for users of VSCode) run the [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) extension, which will automatically provide simple spell checks for code and documentation as you write it.
58+
Especially when writing documentation, but also when writing normal code, it can be useful to have a spellchecker running through your texts. While code can be copied into a spellchecker and checked there (which is still useful to check grammar), it can also be very useful to (for users of VSCode) run the [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) extension. This will automatically provide simple spell-checking for code and documentation as you write it.

0 commit comments

Comments
 (0)