Skip to content

Commit

Permalink
docs: typos
Browse files Browse the repository at this point in the history
  • Loading branch information
JorisVincent committed May 13, 2023
1 parent 44c17bf commit ce4683d
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 10 deletions.
3 changes: 1 addition & 2 deletions docs/getting_started/composition.md
Expand Up @@ -11,9 +11,8 @@ kernelspec:
---

# Composing stimuli, composed stimuli

Most stimuli consist not just of one shape or element,
but they consists of a composition of multiple components.
but consist of a composition of multiple components.
The geometric {py:mod}`components <stimupy.components>`
form the basic building blocks for all stimuli implemented in `stimupy`.
In this tutorial, we will explore how a simple example stimulus consisting of multiple geometric elements,
Expand Down
3 changes: 2 additions & 1 deletion docs/getting_started/replicate.md
Expand Up @@ -20,7 +20,8 @@ and thus specific existing parameterizations can be recreated.

For a large selection of the generic {py:mod}`stimupy.stimuli`,
there are specific parameterizations in the published literature.
In order to make it easier for the community to access and work with these stimuli, we have re-implemented some existing stimulus sets in stimupy,
In order to make it easier for the community to access and work with these stimuli,
we have re-implemented some existing stimulus sets in stimupy,
under the corresponding {py:mod}`stimupy.papers`.

```{code-cell}
Expand Down
2 changes: 1 addition & 1 deletion docs/howtos/export.md
Expand Up @@ -38,7 +38,7 @@ since JSON syntax is very similar to Python syntax for lists and dicts.
as the whole stimulus-dict ({py:func}`stimupy.utils.export.to_json`)

### MATLAB `.mat`
For using stimuli in a MATLAB environment,
To use stimuli in a MATLAB environment,
e.g., in a PsychToolBox-based experiment,
or a computational model that is (only) implemented in MATLAB,
the stimuli have to be exported to a format that MATLAB can interpret.
Expand Down
9 changes: 5 additions & 4 deletions docs/howtos/share.md
Expand Up @@ -3,7 +3,8 @@ A core principle of `stimupy` is sharing and reusing stimuli.
One part of this endeavor is the large number of stimuli that are already implemented,
such that you can generate various parameterizations of these
without having to write any custom code.
Besides this, we are hoping that people who are using `stimupy` for their stimulus generation want to add and hence share their stimulus implementations with other `stimupy`-users.
Besides this, we are hoping that people who use `stimupy` for their stimulus generation
want to share their stimulus implementations with other `stimupy`-users.

## What to share?
To accurately reproduce a stimulus,
Expand Down Expand Up @@ -77,9 +78,9 @@ Thus, you'll need to:
- provide all parameter-values for this stimulus, ideally by [exporting them](export.md).
For just sharing parameter-values, we recommend exporting the stimulus-`dict`
without the `img` and `masks` to a [JSON file](./export.md).
The reason for this is because JSON files are both human-readable -- so that a non-stimupy / non-Python
recipient can still evaluate the parameter values -- and safely machine-readable
-- so that a Python / stimupy user can easily load and recreate the stimulus.
The reason for this is that JSON files are both human-readable --
so that a non-stimupy / non-Python recipient can still evaluate the parameter values --
and safely machine-readable -- so that a Python / stimupy user can easily load and recreate the stimulus.

%% SOMETHING ABOUT HASHING

Expand Down
2 changes: 1 addition & 1 deletion docs/topic_guides/dimensions.md
Expand Up @@ -98,7 +98,7 @@ plot_stim(stim)
```

## Distance metric
We term these above described axes a _`distance_metric`_,
We term these aforementioned axes a _`distance_metric`_,
as they measure distance from some point of origin.
This way of thinking is especially important
for wave specifications in {py:mod}`stimupy.components.waves`
Expand Down
2 changes: 1 addition & 1 deletion docs/topic_guides/waves.md
Expand Up @@ -160,7 +160,7 @@ for a given sampling rate ($\sim$ ppd)
```
````

If desired (i.e. if _`round_phase_width=True`_, `stimupy` supports the user in cases where the given parameter values
If desired (i.e. if _`round_phase_width=True`_), `stimupy` supports the user in cases where the given parameter values
result in a poor periodicity $\times$ resolution combination.
Specifically, it will adjust/round the _periodicity_ parameters to try and accomplish
the closest possible version of the stimulus, and warn you about this change.
Expand Down

0 comments on commit ce4683d

Please sign in to comment.