ESMCI / ESMCI/cime

URL suggestion for python config file format description

Open
#2,592 2 comments 0 reactions 0 assignees View on GitHub
Assigned Low Priority tp: documentation
Dominant language
Python
Stars
174
Forks
225
Avg merge
1d 16h
Merged PRs (30d)
14

Description

The CIME documentation for the $HOME/.cime/config, at
https://esmci.github.io/cime/users_guide/cime-config.html
points to documentation that seems to primarily describe how to parse python config files.

Please consider adding the following URL, which points to a description of the config file format itself:
https://docs.python.org/3/library/configparser.html#supported-ini-file-structure

I think this information is useful to a user not familiar with this format (such as myself).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.