Skip to content

Commit c829cf6

Browse files
committed
Final tidy ups for documentation.
1 parent 2237152 commit c829cf6

File tree

6 files changed

+15
-15
lines changed

6 files changed

+15
-15
lines changed

docs/source/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@ or targeted [User Guides](pages/user_guides/index). \
8181
``datashuttle`` can be used through a graphical interface or Python API.
8282

8383
Have questions, issues or feedback? Get in contact through
84-
[GitHub Issues](https://github.com/neuroinformatics-unit/datashuttle/issues)
84+
[GitHub issues](https://github.com/neuroinformatics-unit/datashuttle/issues)
8585
or our
86-
[Zulip Chat.](https://neuroinformatics.zulipchat.com/#narrow/stream/405999-DataShuttle)
86+
[Zulip chat.](https://neuroinformatics.zulipchat.com/#narrow/stream/405999-DataShuttle)
8787

8888
```{toctree}
8989
:maxdepth: 2

docs/source/pages/community/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ in ``datashuttle`` and
1111
[**NeuroBlueprint**](https://neuroblueprint.neuroinformatics.dev).
1212
Please get in contact with any thoughts on how these tools can be
1313
improved by opening a
14-
[GitHub Issue](https://github.com/neuroinformatics-unit/datashuttle/issues)
14+
[GitHub issue](https://github.com/neuroinformatics-unit/datashuttle/issues)
1515
or by joining our
16-
[Zulip Chat](https://neuroinformatics.zulipchat.com/#narrow/stream/405999-DataShuttle).
16+
[Zulip chat](https://neuroinformatics.zulipchat.com/#narrow/stream/405999-DataShuttle).
1717

1818
To see what we have planned for the future of **NeuroBlueprint** and ``datashuttle``, visit
1919
our [Guiding Principles](guiding-principles.md) and [Roadmap](roadmap.md).

docs/source/pages/examples/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ Using ``datashuttle`` to create project folders in a behavioural-data acquisitio
2323
:link-type: doc
2424
:class-img-top: tutorial-link-image
2525

26-
As script used to validate all of a lab's
27-
NeuroBlueprint-formatted projects at once.
26+
A script used to validate every project in a lab at once.
2827

2928
:::
3029

docs/source/pages/get_started/quick-validate-project.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Strict Mode
4444
in the project. By default, non-[NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev/latest/index.html) folders (e.g. a folder
4545
called `my_stuff` in the `rawdata`) are allowed, and only folders
4646
starting with `sub-` or `ses-` prefix are checked. In `Strict Mode`,
47-
any folder not prefixed with `sub-`, `ses-` or a valid datatype will
47+
any folder with a name not prefixed with `sub-`, `ses-` or a valid datatype will
4848
raise a validation issue.
4949

5050
:::
@@ -66,10 +66,10 @@ quick_validate_project(
6666
```
6767

6868
In this case, `display_mode=error` will result in an error on the first encountered validation issue.
69-
Otherwise, `"warn"` will show a python warning for all detected issues, while `"print"` will print directly to console.
69+
Otherwise, `"warn"` will show a python warning for all detected issues, while `"print"` will print directly to the console.
7070

71-
See the [](datashuttle.quick_validate_project) API documentation at the link,
72-
for full details of parameters including the important argument ``strict_mode``
71+
See the [](datashuttle.quick_validate_project) API documentation
72+
for full details of parameters, including the important argument ``strict_mode``
7373
that controls how validation is performed.
7474

7575
:::

docs/source/pages/get_started/set-up-a-project.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ project.create_folders("rawdata", "sub-001", "ses-001_@DATE@", datatype=["ephys"
100100
::::
101101

102102
Now, this project is ready for creating and validating
103-
folders to the [NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev/latest/index.html) standard. See the [create folders](how-to-create-folders)
103+
folders to the [NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev/latest/index.html) standard. See [create folders](how-to-create-folders)
104104
and [validate folders](tutorial-validation) for details.
105105

106106
If you would also like to transfer files to a central machine, see the next section.
@@ -128,7 +128,7 @@ Therefore, we will need to provide:
128128
<br>
129129

130130
How the **central path** is set depends on whether your connection to
131-
central storage is as a
131+
central storage is a
132132
[mounted drive](new-project-mounted-drive)
133133
or via
134134
[SSH](new-project-ssh).

docs/source/pages/user_guides/create-folders.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,8 @@ will create the folders within the project.
8181

8282
A number of useful shortcuts to streamline this process are described below.
8383

84-
### `Create` shortcuts
84+
**`Create`** **shortcuts**
85+
8586

8687
The `Create` tab has a lot of useful shortcuts.
8788

@@ -114,8 +115,8 @@ Copy the full filepath.
114115
: `CTRL+Q` will copy the entire filepath of the file or
115116
folder.
116117

117-
118-
### `Create` Settings
118+
\
119+
**`Create`** **Settings**
119120

120121
Click the `Settings` button on the `Create` tab to set
121122
the top-level folder, and bypass validation.

0 commit comments

Comments
 (0)