Skip to content

Commit

Permalink
fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
younesStrittmatter committed Oct 20, 2024
1 parent d400e5c commit 9c86ee5
Show file tree
Hide file tree
Showing 10 changed files with 78 additions and 82 deletions.
2 changes: 1 addition & 1 deletion docs/contribute/core.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Core contributions are changes to AutoRA which aren't experimentalists, (synthetic) experiment runners, or theorists.
The primary purpose of the core is to provide utilities for:

- describing experiments and handling workflows (in the [`autora-core` package](https://github.com/autoresearch/autora-core))
- describing experiments and handling workflows (in the [`autora-core` package](https://github.com/autoresearch/autora-core)
- run synthetic experiments (currently in the [`autora-synthetic` package](https://github.com/autoresearch/autora-synthetic). Synthetic experiment runners may be submitted as pull requests to the
[`autora-synthetic`](https://github.com/AutoResearch/autora-synthetic/blob/main/CONTRIBUTING.md) package, providing they
require no additional dependencies. However, if your contribution requires additional dependencies, you can submit it as a full package following
Expand Down
2 changes: 1 addition & 1 deletion docs/contribute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ In general, AutoRA follows the [PEP 8 – Style Guide for Python Code](https://p

### Documentation Style

For documenation, AutoRA adheres to the maxim, "Everything should be made as simple as possible, but no simpler." That is, we strive to make documenation clear and comprehensive, but as concise and digestible as possible. We also encourage formatting and hyperlinking that facilitate understanding and make navigation of the docs intuitive. Finally, we encourage a strong form of title case for headings — that is, for all titles and subtitles, the first letter of each word should be capitalized, such as in the following example: This Is An Example Title
For documentation, AutoRA adheres to the maxim, "Everything should be made as simple as possible, but no simpler." That is, we strive to make documentation clear and comprehensive, but as concise and digestible as possible. We also encourage formatting and hyperlinking that facilitate understanding and make navigation of the docs intuitive. Finally, we encourage a strong form of title case for headings — that is, for all titles and subtitles, the first letter of each word should be capitalized, such as in the following example: This Is An Example Title


## Module Contributions
Expand Down
8 changes: 4 additions & 4 deletions docs/contribute/modules/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ you will still be able to install your package separately, in addition to `autor
### Add Documentation (Optional)

It is highly encouraged that you add documentation of your package in `docs/index.md`. You can also add new or delete unnecessary pages
in the `docs` folder. However you structure your documentation, be sure that structure is reflected in the `mkdocs.yml` file.
in the `docs` folder. However, you structure your documentation, be sure that structure is reflected in the `mkdocs.yml` file.

You are also encouraged to describe basic usage of your module in the
python notebook ``Basic Usage.ipynb`` in the `docs` folder. Finally you can outline the basic setup of your module in
python notebook ``Basic Usage.ipynb`` in the `docs` folder. Finally, you can outline the basic setup of your module in
the `docs/quickstart.md` file.

*Note: Documentation is required for your module to become part of the main
Expand All @@ -73,7 +73,7 @@ pip install -e ".[dev]"
There are several ways to publish your package, depending on how you set up your repository.

### Publishing Via GitHub Actions
If you used the **cookiecutter template** with the advanced setup, and uploaded your repository to github.com, then you can use Github Actions to automatically publish your package to PyPI or Conda.
If you used the **cookiecutter template** with the advanced setup, and uploaded your repository to GitHub, then you can use GitHub Actions to automatically publish your package to PyPI or Conda.

Note, if your repository is part of the [AutoResearch Organization](https://github.com/AutoResearch) you can skip the step below for creating a new secret in your repository.

Expand Down Expand Up @@ -269,7 +269,7 @@ mkdocs serve
the right place and renders correctly.


Once everything is working locally, make a new PR on [github.com](https://github.com/autoresearch/autora) with your
Once everything is working locally, make a new PR on [GitHub.com](https://github.com/autoresearch/autora) with your
changes. Include:

- a description of the changes to the package, and
Expand Down
12 changes: 5 additions & 7 deletions docs/examples/closed-loop-basic/notebooks/sweetbean.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"- a fixation cross is displayed for 1500 ms\n",
"- a set of two dot stimuli is displayed, one on the left and one on the right for 200ms. Each set contains a certain number of dots and the participant has to indicate whether the numbers of dots in the two sets are the same or different by pressing `y` or `n`.\n",
"\n",
"You can find more in-depth tutorials on automated web experiment generation at the [SweetBean Website](https://autoresearch.github.io/sweetbean/)).\n",
"You can find more in-depth tutorials on automated web experiment generation at the [SweetBean Website](https://autoresearch.github.io/sweetbean/).\n",
"\n"
]
},
Expand Down Expand Up @@ -221,9 +221,7 @@
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Note that the dot stimulus is shown for 2000ms (``duration=2000``). It consits of two set of dots (``number_of_apertures=2``), which are parameterized by the two timeline variables ``number_of_oobs=[dot_stimulus_left, dot_stimulus_right]``. Finally, we allow participants to record a response on each stimulus, indicating whether the dots match or not by pressing the respective keys for `y` and `n` (``choices=[\"y\", \"n\"]``)"
]
"source": "Note that the dot stimulus is shown for 2000ms (``duration=2000``). It consists of two set of dots (``number_of_apertures=2``), which are parameterized by the two timeline variables ``number_of_oobs=[dot_stimulus_left, dot_stimulus_right]``. Finally, we allow participants to record a response on each stimulus, indicating whether the dots match or not by pressing the respective keys for `y` and `n` (``choices=[\"y\", \"n\"]``)"
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -255,7 +253,7 @@
"source": [
"## Experiment Block Sequence\n",
"\n",
"Now that we have specified all of our experiment blocks, we put them together into an experiment. The function below compiles the experiment and converts it into an html file."
"Now that we have specified all of our experiment blocks, we put them together into an experiment. The function below compiles the experiment and converts it into a html file."
]
},
{
Expand All @@ -272,7 +270,7 @@
"# define the entire experiment\n",
"experiment = Experiment([instruction_block, task_block, exit_block])\n",
"\n",
"# export expeirment to html file\n",
"# export experiment to html file\n",
"experiment.to_html(\"psychophysics_experiment.html\")"
]
},
Expand All @@ -289,7 +287,7 @@
"source": [
"## Writing a Function to Automate the Generation of Stimulus Sequences\n",
"\n",
"The function below compiles the code above into a single function, and returns a web-based (java script) experiment, written in ``jsPsych``.\n",
"The function below compiles the code above into a single function, and returns a web-based (JavaScript) experiment, written in ``jsPsych``.\n",
"\n",
"The function takes a timeline, containing a sequence of trials, as input, along with the two levels for the dot stimuli."
]
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/closed-loop-basic/notebooks/sweetpea.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@
}
],
"source": [
"# we can export the experimentla sequence as a dictionary\n",
"# we can export the experimental sequence as a dictionary\n",
"sequence = experiments_to_dicts(block, experiment)\n",
"print(sequence)"
]
Expand Down Expand Up @@ -229,7 +229,7 @@
"\n",
" block = CrossBlock(design, crossing, constraints)\n",
"\n",
" # synthesize trialsequence\n",
" # synthesize trial sequence\n",
" experiment = synthesize_trials(block, 1, CMSGen)\n",
"\n",
" # export as dictionary\n",
Expand Down
Loading

0 comments on commit 9c86ee5

Please sign in to comment.