Skip to content

Commit

Permalink
fix typo for word boundaries in doc (#2824)
Browse files Browse the repository at this point in the history
* fix typo for word boundaries in doc

* typo fixes

* Adding Ryan Groneck(me) to mailmap
  • Loading branch information
RyanGroneck authored Oct 8, 2024
1 parent 7e672b8 commit b3af245
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 12 deletions.
3 changes: 3 additions & 0 deletions .mailmap
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,9 @@ Ran Livneh <[email protected]>
Ran Livneh <[email protected]> livnehra <[email protected]>
Ran Livneh <[email protected]> Ran Livneh <[email protected]>

Ryan Groneck <[email protected]>
Ryan Groneck <[email protected]> RyanGroneck <[email protected]>

Sampark Sharma <[email protected]>

Shilpi Prasad <[email protected]>
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/development/known_projects.inc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
.. _`PROJECTNAME mailing list`: http://projects.scipy.org/mailman/listinfo/nipy-devel

.. numpy
.. _numpy: hhttp://numpy.scipy.org
.. _numpy: http://numpy.scipy.org
.. _`numpy github`: http://github.com/numpy/numpy
.. _`numpy mailing list`: http://mail.scipy.org/mailman/listinfo/numpy-discussion

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/tools/hdf_writer.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Modifed Usage\n",
"## Modified Usage\n",
"\n",
"In `BasePlasma` class, the way properties of object are collected is different. It does not uses `hdf_properties` attribute.<br>\n",
"That\\`s why , `PlasmaWriterMixin` (which extends `HDFWriterMixin`) changes how the properties of `BasePlasma` class will be collected, by changing `get_properties` function.<br>\n",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
"\n",
"def check_existance(data_dict, info):\n",
" \"\"\"\n",
" Checks to see if a data poitn already exists in data_dict.\n",
" Checks to see if a data point already exists in data_dict.\n",
" Returns true if it exists, false if it does not.\n",
" \n",
" Parameters\n",
Expand Down Expand Up @@ -194,7 +194,7 @@
" cpu_file,):\n",
" \"\"\"\n",
" This function generates data for running a tardis file on different numbers of threads different times.\n",
" It writes the data to two dictionaries and their respecitve files.\n",
" It writes the data to two dictionaries and their respective files.\n",
" \n",
" This function can be modified to write to as many or as few dictionaries and files as necessary.\n",
" In order to test different parameters, the index into the tardis_config must be adjusted. This must be done \n",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"Note\n",
"\n",
"\n",
"This parser has been developed for the (not publically available) development version of Arepo, not the public version. Althought it should also work with snapshots from the public version, this has not been tested. If you run into trouble loading the snapshot using the built-in functions, try providing the data manually. \n",
"This parser has been developed for the (not publicly available) development version of Arepo, not the public version. Although it should also work with snapshots from the public version, this has not been tested. If you run into trouble loading the snapshot using the built-in functions, try providing the data manually. \n",
"\n",
"\n",
"</div>"
Expand Down Expand Up @@ -121,7 +121,7 @@
"source": [
"As a first step, the relevant data has to be loaded from an Arepo snapshot, i.e. an output file of Arepo. In case you have the arepo-snap-util package installed, you can use the built in wrapper (as described below) to load the relevant data. In case you do not have this package installed or want to load the snapshot in a different way, you can manually provide the relevant data and continue with the next step.\n",
"\n",
"If you're using the built-in tool, you will need to provide the path to the snapshot file, a list with the elements you want to include in your TARDIS model, as well as the species file with which the Arepo simulation was run. *(The species file should contain one header line, followed by two colums, where the first contains the names of all the species and is used to find the indices of the individual species within the snapshot. The second column is not used by the loader.)*"
"If you're using the built-in tool, you will need to provide the path to the snapshot file, a list with the elements you want to include in your TARDIS model, as well as the species file with which the Arepo simulation was run. *(The species file should contain one header line, followed by two columns, where the first contains the names of all the species and is used to find the indices of the individual species within the snapshot. The second column is not used by the loader.)*"
]
},
{
Expand Down Expand Up @@ -296,7 +296,7 @@
"id": "09cfe94f",
"metadata": {},
"source": [
"Next you can create the profiles acccording to the model option you selected. A diagnostic plot will be shown per default, but this behaviour can be turned off with the option `show_plot=False`. The plot will always show both the positve and negative axis."
"Next you can create the profiles according to the model option you selected. A diagnostic plot will be shown per default, but this behaviour can be turned off with the option `show_plot=False`. The plot will always show both the positive and negative axis."
]
},
{
Expand Down Expand Up @@ -364,7 +364,7 @@
"metadata": {},
"source": [
"### Selecting a specific region\n",
"In many cases you only want a very specific region from the snapshot, e.g. cutting out the dense, optically thick regions. This can be acchieved using the keywords `inner_radius` and `outer_radius`."
"In many cases you only want a very specific region from the snapshot, e.g. cutting out the dense, optically thick regions. This can be achieved using the keywords `inner_radius` and `outer_radius`."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/io/configuration/components/models/csvy_full_rad.csvy
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ datatype:
fields:
- name: velocity
unit: km/s
desc: velocities of shell outer bounderies.
desc: velocities of shell outer boundaries.
- name: density
unit: g/cm^3
desc: density of shell.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
datatype:
fields:
- desc: velocities of shell outer bounderies.
- desc: velocities of shell outer boundaries.
name: velocity
unit: km/s
- desc: mean density of shell.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
datatype:
fields:
- desc: velocities of shell outer bounderies.
- desc: velocities of shell outer boundaries.
name: velocity
unit: km/s
- desc: mean density of shell.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
datatype:
fields:
- desc: velocities of shell outer bounderies.
- desc: velocities of shell outer boundaries.
name: velocity
unit: km/s
- desc: mean density of shell.
Expand Down

0 comments on commit b3af245

Please sign in to comment.