Skip to content

Commit cf9a662

Browse files
committed
reST fixes
1 parent e38d299 commit cf9a662

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

doc/contributing.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@ A detailed explanation of steps for contributing MITgcm code edits:
117117

118118

119119
3. Switch to the master branch, and make sure we're up to date.
120+
120121
``git checkout master``
121122

122123
Git checkout is the command to switch branches; this puts you on master branch, in the event you were sufficiently git-savy already to have created different branches in your git-cloned local repository. (It won’t hurt to type this if you are already on the master branch)
@@ -145,6 +146,7 @@ A detailed explanation of steps for contributing MITgcm code edits:
145146
- if you are fixing a more involved bug or adding a new feature, such that many changes are required, it is preferable to break your contribution into multiple commits (each documented separately) rather than submitting one massive commit; each commit should encompass a single conceptual change to the code base, regardless of how many files it touches. This will allow the MITgcm maintainers to more easily understand your proposed changes and will expedite the review process.
146147

147148
6. Now we “push” our modified branch with committed changes onto the origin remote in the GitHub cloud. This effectively updates your GitHub cloud copy of the MITgcm repo to reflect the wonderful changes you are contributing.
149+
148150
``git push -u origin bugfix``
149151

150152
7. Finally create a “pull request” (a.k.a. “PR”; in other words, you are requesting that the maintainers pull your changes into the main code repository). In GitHub, go to the fork of the project that you made (https://github.com/user_name/MITgcm66h.git). There is a button for "Compare and Pull" in your newly created branch. Click the button! Now you can add a final succinct summary description of what you've done in your commit(s), and flag up any issues. At last the maintainers will be notified and be able to peruse your changes! While the PR remains open, you can go back to step #5 and make additional edits, git adds, git commits, and then redo step #6; such changes will be added to the PR (and maintainers re-notified). The pull request remains open until either the maintainers fully accept and merge your code changes into the main repository, or decide to reject your changes. But much more likely than the latter, you will instead be asked to respond to feedback, modify your code changes in some way, and/or clean up your code to better satisfy our style requirements, etc., and the pull request will remain open instead of outright rejection.

doc/getting_started/getting_started.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _chap_getting_started:
22

33
Getting Started with MITgcm
4-
****************************
4+
***************************
55

66
This chapter is divided into two main parts. The first part, which is
77
covered in sections :numref:`whereToFindInfo` through
@@ -102,7 +102,7 @@ Be forewarned, this will only work if you have not modified ANY of the files in
102102
.. _approach2:
103103

104104
Approach 2: I’m willing to learn some basic Git functionality
105-
-----------------------------------------------------------
105+
-------------------------------------------------------------
106106

107107
Need to figure out level of detail here... suggest workflow etc.?
108108

@@ -146,7 +146,7 @@ description of the directory structure of the model under the root tree.
146146
that generates the adjoint code. The latter is described in detail in
147147
part [chap.ecco]. This directory also contains the subdirectory
148148
build\_options, which contains the ‘optfiles’ with the compiler
149-
options for the different compilers and machines that can run MITgcm (see :numref:`genmake_optfiles`).
149+
options for the different compilers and machines that can run MITgcm (see :numref:`genmake2_optfiles`).
150150

151151
- ``utils``: this directory contains various utilities. The
152152
subdirectory ``knudsen2`` contains code and a makefile that compute
@@ -470,7 +470,7 @@ The most important command-line options are:
470470
Running the model
471471
=================
472472

473-
If compilation finished successfully (:numref:`buildingCode`) then an
473+
If compilation finished successfully (:numref:`building_code`) then an
474474
executable called ``mitgcmuv`` will now exist in the local directory.
475475

476476
To run the model as a single process (i.e., not in parallel) simply

doc/getting_started/tank/tank.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,10 @@ this example.
9393
These lines set horizontal and vertical diffusion coefficients for
9494
temperature and salinity. Similarly to the friction coefficients, the
9595
values are a couple of orders of magnitude less than most
96-
configurations.
96+
configurations.
9797

9898

99-
- Line 17, `f0=0.5`, this line sets the
100-
coriolis term, and represents a tank spinning at about 2.4 rpm.
99+
- Line 17, `f0=0.5`, this line sets the coriolis term, and represents a tank spinning at about 2.4 rpm.
101100

102101
- Lines 23 and 24
103102

0 commit comments

Comments
 (0)