Skip to content

Commit a52b3ca

Browse files
committed
Minor fixes to documentation formatting
1 parent 62e6782 commit a52b3ca

File tree

3 files changed

+15
-5
lines changed

3 files changed

+15
-5
lines changed

documentation/source/latex-rmg.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ steps using a general understanding of how molecules react. This documentation i
1313
+---------------------------------------------+----------------------------------------------------------------------------------------+
1414
| create mechanisms automatically | Download RMG with the RMG User's Guide |
1515
+---------------------------------------------+----------------------------------------------------------------------------------------+
16-
| make transition state theory calculations | Run Arkane after downloading RMG. See the Arkane User's Guide |
16+
| make transition state theory calculations | Run Arkane after downloading RMG. See the Arkane User's Guide |
1717
+---------------------------------------------+----------------------------------------------------------------------------------------+
1818
| post an issue with RMG | `GitHub issues page <https://github.com/ReactionMechanismGenerator/RMG-Py/issues>`__ |
1919
+---------------------------------------------+----------------------------------------------------------------------------------------+

documentation/source/reference/arkane/qchemlog.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
arkane.qchem.QchemLog
33
*****************************
44

5-
.. autoclass:: arkane.qchem.QchemLog
5+
.. autoclass:: arkane.qchem.QChemLog

rmgpy/molecule/pathfinder.py

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,7 @@ def find_lone_pair_multiple_bond_paths(atom1):
276276
`atom1` indicates the localized lone pair site. Currently carbenes are excluded from this path.
277277
278278
Examples:
279+
279280
- N2O (N#[N+][O-] <-> [N-]=[N+]=O)
280281
- Azide (N#[N+][NH-] <-> [N-]=[N+]=N <-> [N-2][N+]#[NH+])
281282
- N#N group on sulfur (O[S-](O)[N+]#N <-> OS(O)=[N+]=[N-] <-> O[S+](O)#[N+][N-2])
@@ -308,6 +309,7 @@ def find_adj_lone_pair_radical_delocalization_paths(atom1):
308309
could have been generated as a resonance structure of R[::O][::O.].
309310
310311
The radical site (atom1) could be either:
312+
311313
- `N u1 p0`, eg O=[N.+][:::O-]
312314
- `N u1 p1`, eg R[:NH][:NH.]
313315
- `O u1 p1`, eg [:O.+]=[::N-]; not allowed when adjacent to another O atom
@@ -318,6 +320,7 @@ def find_adj_lone_pair_radical_delocalization_paths(atom1):
318320
- any of the above with more than 1 radical where possible
319321
320322
The non-radical site (atom2) could respectively be:
323+
321324
- `N u0 p1`
322325
- `N u0 p2`
323326
- `O u0 p2`
@@ -348,11 +351,13 @@ def find_adj_lone_pair_radical_delocalization_paths(atom1):
348351

349352
def find_adj_lone_pair_multiple_bond_delocalization_paths(atom1):
350353
"""
351-
Find all the delocalization paths of atom1 which either:
354+
Find all the delocalization paths of atom1 which either
355+
352356
- Has a lonePair and is bonded by a single/double bond (e.g., [::NH-]-[CH2+], [::N-]=[CH+]) -- direction 1
353357
- Can obtain a lonePair and is bonded by a double/triple bond (e.g., [:NH]=[CH2], [:N]#[CH]) -- direction 2
354358
355359
Giving the following resonance transitions, for example:
360+
356361
- [::NH-]-[CH2+] <=> [:NH]=[CH2]
357362
- [:N]#[CH] <=> [::N-]=[CH+]
358363
- other examples: S#N, N#[S], O=S([O])=O
@@ -388,11 +393,13 @@ def find_adj_lone_pair_multiple_bond_delocalization_paths(atom1):
388393

389394
def find_adj_lone_pair_radical_multiple_bond_delocalization_paths(atom1):
390395
"""
391-
Find all the delocalization paths of atom1 which either:
396+
Find all the delocalization paths of atom1 which either
397+
392398
- Has a lonePair and is bonded by a single/double bond to a radical atom (e.g., [::N]-[.CH2])
393399
- Can obtain a lonePair, has a radical, and is bonded by a double/triple bond (e.g., [:N.]=[CH2])
394400
395401
Giving the following resonance transitions, for example:
402+
396403
- [::N]-[.CH2] <=> [:N.]=[CH2]
397404
- O[:S](=O)[::O.] <=> O[S.](=O)=[::O]
398405
@@ -429,9 +436,12 @@ def find_N5dc_radical_delocalization_paths(atom1):
429436
"""
430437
Find all the resonance structures of an N5dc nitrogen atom with a single bond to a radical N/O/S site, another
431438
single bond to a negatively charged N/O/S site, and one double bond (not participating in this transformation)
439+
432440
Example:
441+
433442
- N=[N+]([O])([O-]) <=> N=[N+]([O-])([O]), these structures are isomorphic but not identical, the transition is
434-
important for correct degeneracy calculations
443+
important for correct degeneracy calculations
444+
435445
In this transition atom1 is the middle N+ (N5dc), atom2 is the radical site, and atom3 is negatively charged
436446
A "if atom1.atomType.label == 'N5dc'" check should be done before calling this function
437447
"""

0 commit comments

Comments
 (0)