Skip to content

Commit

Permalink
Minor fixes in docstrings for dens_grid and psi_grid
Browse files Browse the repository at this point in the history
  • Loading branch information
yachmena committed Aug 20, 2023
1 parent a50cb3c commit b0ad66f
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions richmol/rotdens.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ def dens_grid(h: CarTens,
Returns:
Union[Dict[Any, Any], np.ndarray]: Densitties on the grid of Euler angles.
If `form` is 'block', it returns a dictionary. For 'full', it returns a 2D array.
If `form` is 'block', it returns a dictionary. For 'full', it returns a 5D array
if `diag_only` is False, and a 4D array if `diag_only` is True.
See examples below.
Example for 'block':
Expand Down Expand Up @@ -171,7 +173,9 @@ def psi_grid(h: CarTens,
Returns:
Union[Dict[Any, Any], np.ndarray]: Wave functions on the grid of Euler angles.
If `form` is 'block', it returns a dictionary. For 'full', it returns a 2D array.
If `form` is 'block', it returns a dictionary. For 'full', it returns a 5D array,
if `sum_over_vib` is False, and a 4D array, if `sum_over_vib` is True.
See examples below.
Example for 'block':
Expand Down

0 comments on commit b0ad66f

Please sign in to comment.