[ci skip] lets fix typos in documentation too

pmocz · warrickball · commit 2d7c7b94b8a7 · 2025-01-08T23:44:21.000Z
diff --git a/docs/source/_typos.toml b/docs/source/_typos.toml
@@ -0,0 +1,11 @@
+[default]
+extend-ignore-identifiers-re = [
+    "ACI-*",
+    "gam_*",
+    "plas_*",
+    "2nd",
+]
+
+[default.extend-words]
+# Don't correct the surname "Teh"
+Xwindows = "Xwindows"
diff --git a/docs/source/assets/atm-user-guide.txt b/docs/source/assets/atm-user-guide.txt
@@ -112,7 +112,7 @@ controls) are as follows:
 
   - MESA uses pre-computed tables, from separate model atmosphere
     calculations, to interpolate T_surf and P_surf values for the
-    boundary conditions. The interpolations are peformed using the
+    boundary conditions. The interpolations are performed using the
     effective temperature Teff and log10-surface gravity logg as
     independent variables. The choice of table is set by the
     'atm_table' control:
diff --git a/docs/source/atm/table.rst b/docs/source/atm/table.rst
@@ -4,7 +4,7 @@ Table Atmospheres
 When the ``atm_option`` control is set to ``'table'``, MESA uses
 pre-computed tables from separate model atmosphere calculations to
 interpolate :math:`T_{\rm surf}` and :math:`P_{\rm surf}` values for
-the boundary conditions. The interpolations are peformed using
+the boundary conditions. The interpolations are performed using
 :math:`T_{\rm eff}` and :math:`\log g` as independent variables. The
 ``atm_table`` control determines the choice of table, as follows:
 
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -24,7 +24,7 @@ New Features
 Bug Fixes
 ---------
 
-fixed small bug in star/private/create_initial_model.f90 that will have a small effect on creating inital models
+fixed small bug in star/private/create_initial_model.f90 that will have a small effect on creating initial models
 
 
 .. note:: Before releasing a new version of MESA, move `Changes in main` to a new section below with the version number as the title, and add a new `Changes in main` section at the top of the file (see ```changelog_template.rst```).
@@ -412,7 +412,7 @@ like to see the changes without modifying the file.
 
 ``sed`` is a standard tool that is included with macOS and most Linux distributions.
 For convenience, we have also included a bash script that will call a version of
-this ``sed`` command (along with ``sed`` commands for the next changlog entry as well)
+this ``sed`` command (along with ``sed`` commands for the next changelog entry as well)
 to update all inlist files (``inlist*``), which you can run in any work directory
 where you want to update every inlist by invoking ::
 
@@ -687,7 +687,7 @@ about the ``net_general_info`` derived type. ``g`` can be had from a call to ``g
 The pointer array ``net_work`` and its size ``net_lwork`` have been removed from the net interface, thus these variables should be removed form any ``other_net_get`` and ``other_split_burn`` hooks.
 The following routines have also been removed as they are no longer needed ``net_work_size``, ``get_net_rate_ptrs``, ``net_1_zone_burn_work_size``, ``get_burn_work_array_pointers``, ``net_1_zone_burn_const_density_work_size``, and ``get_burn_const_density_work_array_pointers``
 
-Previously you could pass ``arg_not_provided`` for either the temperature (density) or log(temperature) (log(density)). Now you must pass both explicity.
+Previously you could pass ``arg_not_provided`` for either the temperature (density) or log(temperature) (log(density)). Now you must pass both explicitly.
 
 ADIPLS
 ------
diff --git a/docs/source/developing/infrastructure.rst b/docs/source/developing/infrastructure.rst
@@ -88,7 +88,7 @@ service.
 Website
 ^^^^^^^
 
-We still use the mesa.sourceforge.net website domian name, but only for a top-level
+We still use the mesa.sourceforge.net website domain name, but only for a top-level
 redirect to docs.mesastar.org.
 
 The source code for the old sourceforge site lives at https://github.com/MESAHub/mesa-website.
diff --git a/docs/source/developing/new_developers.rst b/docs/source/developing/new_developers.rst
@@ -90,4 +90,4 @@ Changelog
 ---------
 
 * Initial document approved December 5, 2022
-* "Infrastucture Access for Collaborators" section adopted March 1, 2024
+* "Infrastructure Access for Collaborators" section adopted March 1, 2024
diff --git a/docs/source/developing/profiling.rst b/docs/source/developing/profiling.rst
@@ -35,7 +35,7 @@ To visualize the data use:
 
     massif-visualizer massif.out.$PID
 
-which is avilable from `<https://github.com/KDE/massif-visualizer>`_ or through your local package manager.
+which is available from `<https://github.com/KDE/massif-visualizer>`_ or through your local package manager.
 
 
 CPU Usage
@@ -68,7 +68,7 @@ To visualize the data use:
 
     kcachegrind callgrind.out.*
 
-which is avilable from `<https://kcachegrind.github.io/html/Home.html>`_ or through your local package manager.
+which is available from `<https://kcachegrind.github.io/html/Home.html>`_ or through your local package manager.
 
 
 An alternative non-interactive visualization can be produced via `gprof2dot.py <https://github.com/jrfonseca/gprof2dot>`_ and `graphviz <https://graphviz.org/>`_.  
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -155,7 +155,7 @@ Turbulence (``turb``)
 =====================
 
 The ``turb`` module provides various mixing theories (semiconvection, thermohaline,
-mixing length thoery, time-dependant convection)
+mixing length theory, time-dependant convection)
 
 .. toctree::
    :maxdepth: 1
diff --git a/docs/source/news.rst b/docs/source/news.rst
@@ -6,7 +6,7 @@ News archive
 
 This page contains links to all the news posted on mesa.sourceforge.net
 
-.. From the orignal markdown we can do: cd $MESA_DIR/docs/source/news;for i in $MESA_WEBSITE_PATH/_posts/*.markdown;do pandoc -s -f markdown -t rst $i > $(basename ${i%%markdown}rst);echo $i;done
+.. From the original markdown we can do: cd $MESA_DIR/docs/source/news;for i in $MESA_WEBSITE_PATH/_posts/*.markdown;do pandoc -s -f markdown -t rst $i > $(basename ${i%%markdown}rst);echo $i;done
 
 .. The TOC can be regenerated with: cd $MESA_DIR/docs/source/news;for i in *;do echo "    news/$(basename ${i%%.rst})" ;done | tac
 
diff --git a/docs/source/news/2014-03-21-website.rst b/docs/source/news/2014-03-21-website.rst
@@ -14,5 +14,5 @@ If you see errors or have suggestions for improvements, you can email
 Josiah Schwab. Also feel free to open an issue or send a pull request on
 `GitHub <https://github.com/jschwab/mesa-website>`__.
 
-For the full annoucement, see `this mailing list
+For the full announcement, see `this mailing list
 post <https://sourceforge.net/p/mesa/mailman/message/32133212/>`__.
diff --git a/docs/source/news/2014-07-01-zipfiles.rst b/docs/source/news/2014-07-01-zipfiles.rst
@@ -10,4 +10,4 @@ zip archives. A working Subversion installation is therefore no longer a
 pre-requisite for MESA installation.
 
 Future releases will also be offered as zip files (or in another
-similiar archive format).
+similar archive format).
diff --git a/docs/source/news/2017-08-14-new-mesa-users.rst b/docs/source/news/2017-08-14-new-mesa-users.rst
@@ -8,7 +8,7 @@ We are moving the mesa-users mailing list to a new home.
 
 The new address is mesa-users@lists.mesastar.org
 
-You can subscribe to mesa-users, modifiy your subscription options, or
+You can subscribe to mesa-users, modify your subscription options, or
 access the list archive by following the instructions on the `list
 information
 page <https://lists.mesastar.org/mailman/listinfo/mesa-users>`__.
diff --git a/docs/source/summer_schools.rst b/docs/source/summer_schools.rst
@@ -5,7 +5,7 @@ MESA Summer Schools
 History of the MESA Summer School Program
 -----------------------------------------
 
-The MESA Summer Schools (material linked `here <https://cococubed.com/mesa_market/education.html>`_) have traditionally been held in Santa Barbara, California, until 2022. The 2023 MESA Summer School program, branded as `MESA@Konkoly <https://mesahub.github.io/summer-school-2023/>`_, was held in Budapest, Hungary. This was follwed by `MESA Down Under <https://maygpedersen.github.io/mesa-down-under-2024/>`_, hosted in Sydney in June of 2024.
+The MESA Summer Schools (material linked `here <https://cococubed.com/mesa_market/education.html>`_) have traditionally been held in Santa Barbara, California, until 2022. The 2023 MESA Summer School program, branded as `MESA@Konkoly <https://mesahub.github.io/summer-school-2023/>`_, was held in Budapest, Hungary. This was followed by `MESA Down Under <https://maygpedersen.github.io/mesa-down-under-2024/>`_, hosted in Sydney in June of 2024.
 As of 2022, MESA Summer Schools can be run anywhere in the world. The involvement of the MESA developers is encouraged, and we are happy to help. 
 
 
@@ -18,7 +18,7 @@ Preparing a good program takes about a year. Historically, the program has taken
 1 year + out (September/October)
 --------------------------------
 
-- Book a venue. The summer schools have traditionally aimed for approximatley 45 students, one TA per 3 students (15 TAs), and 6 lecturers. These numbers are not strict, but they have worked well in the past. Plan for your venue to accommodate roughly 75 people (lecturers, TAs, students, organizers). Be aware that your venue should have reliable, high-speed internet and enough outlets for every student, TA, and lecturer to plug in their laptop simultaneously. 
+- Book a venue. The summer schools have traditionally aimed for approximately 45 students, one TA per 3 students (15 TAs), and 6 lecturers. These numbers are not strict, but they have worked well in the past. Plan for your venue to accommodate roughly 75 people (lecturers, TAs, students, organizers). Be aware that your venue should have reliable, high-speed internet and enough outlets for every student, TA, and lecturer to plug in their laptop simultaneously. 
 
 
 - Choose your organizational team. For past programs, it has worked well to have a scientific organization committee that includes MESA developers, a local organizational committee comprising individuals at the host institute and/or in the host country who can help with local logistical matters, and a teaching committee.
@@ -37,7 +37,7 @@ We aim for 50-50 gender representation (50% men, 50% women and gender minorities
 ---------------------------------------------
 - Look for and apply to grant funding schemes. Previous supporters of the MESA Summer Schools include the International Research Network of Nuclear Astrophysics (IReNA; USA), the European ChETEC-INFRA network of research infrastructures, and individual research grants (NSF; Marie Curie scheme, ERC scheme). 
 
-- reserve accommodation. Hotel room blocks can be booked for discounted rates. Some univerisites are willing to provide discounted bulk accommodation through their own facilities (e.g. dorms), as was the case at Santa Barbara.
+- reserve accommodation. Hotel room blocks can be booked for discounted rates. Some universities are willing to provide discounted bulk accommodation through their own facilities (e.g. dorms), as was the case at Santa Barbara.
 
 - open the application for students. A template for this is available from Meridith Joyce, Earl Bellinger, or Eoin Farrell (MESAdev). A Google form is a good way to provide the application. Be aware that summer schools have been oversubscribed by more than a factor of 2 in recent years, and be prepared to rank applications in a systematic way. We aim for 50-50 gender representation among students and have a track record of achieving 35%-45% participation from women and gender minorities, on average. 
 
@@ -56,7 +56,7 @@ We aim for 50-50 gender representation (50% men, 50% women and gender minorities
 
 - email the supervisors of potential attendees to confirm that they have their advisor's permission and funding to attend. Be aware that some prospective students may apply without having secured funding and without their advisor's knowledge.
 
-- send acceptances to students, cc-ing superviors, while maintaining a ranked waitlist. If you do not hear back from an accepted student or their supervisor in, for example, 2 weeks, move on to the waitlist. There are typically several students admitted off the waitlist.  
+- send acceptances to students, cc-ing supervisors, while maintaining a ranked waitlist. If you do not hear back from an accepted student or their supervisor in, for example, 2 weeks, move on to the waitlist. There are typically several students admitted off the waitlist.  
 
 4 months out (April)
 --------------------
diff --git a/docs/source/test_suite.rst b/docs/source/test_suite.rst
@@ -211,7 +211,7 @@ This test suite example checks the inward propagation of a carbon burning front
 :ref:`ccsn_IIp`
 ^^^^^^^^^^^^^^^
 
-This test suite example builds a Type IIp supernova model, including Rayleigh-Taylor Instability mixing, for subsquent use in STELLA.
+This test suite example builds a Type IIp supernova model, including Rayleigh-Taylor Instability mixing, for subsequent use in STELLA.
 
 
 :ref:`check_pulse_atm`
@@ -526,7 +526,7 @@ This test case exercises the simplex framework with a check of the chi^2 value f
 :ref:`split_burn_big_net`
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-This test case tests MESA's ability to perfom a split-burn calculation in a 25 |Msun| star during silicon burning.
+This test case tests MESA's ability to perform a split-burn calculation in a 25 |Msun| star during silicon burning.
 
 :ref:`starspots`
 ^^^^^^^^^^^^^^^^
