Skip to content

Improve listing of compatible sampling methods#482

Merged
ConnectedSystems merged 6 commits into
SALib:mainfrom
ConnectedSystems:compatibility-doc
Sep 25, 2021
Merged

Improve listing of compatible sampling methods#482
ConnectedSystems merged 6 commits into
SALib:mainfrom
ConnectedSystems:compatibility-doc

Conversation

@ConnectedSystems
Copy link
Copy Markdown
Member

Noticed that the compatible methods are not correctly displayed when rendered on readthedocs:

Compatible with
------------------
* `morris`

image

Turns out Sphinx pre-defines section headers and does not render custom ones.
To resolve this, I've merged the listings under the "Notes" section.

I plan to place further text on method caveats, pitfalls, and other useful information (as done for the Saltelli method).

Notes
-----
Compatible with:
    `morris` : :func:`SALib.sample.morris.sample`

PR includes miscellaneous clean up (primarily removing whitespace, and other changes to conform to PEP8).

@ConnectedSystems ConnectedSystems merged commit b20ee38 into SALib:main Sep 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant