Skip to content

Commit 2716b2b

Browse files
TorkelEisaacsas
andauthored
Update docs/src/devdocs/dev_guide.md
Co-authored-by: Sam Isaacson <[email protected]>
1 parent 8f067f3 commit 2716b2b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/src/devdocs/dev_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Catalyst release branch*.
3939
### Checking doc builds for errors
4040
When updating documentation, Catalyst will run any Julia code provided within example blocks 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/devdocs/failed_builddocs_link.png)
42-
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).
42+
To check what errors were produced, click 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
4444
### Inspecting documentation of a PR or branch
4545
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.

0 commit comments

Comments
 (0)