Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document case settings #210

Closed
eclare108213 opened this issue Oct 17, 2018 · 4 comments
Closed

document case settings #210

eclare108213 opened this issue Oct 17, 2018 · 4 comments
Assignees

Comments

@eclare108213
Copy link
Contributor

The second column in the case settings table (options, format) needs to be filled out for settings that aren't strings:
https://github.com/CICE-Consortium/CICE/blob/master/doc/source/user_guide/ug_case_settings.rst

@eclare108213
Copy link
Contributor Author

See #207

@duvivier
Copy link
Contributor

@eclare108213
Do you want there to be examples in this table? Otherwise it would be something like "string" as the format for most of these options. However, if we want to show what an example cice.settings file looks like after running cice.setup maybe that would be more useful. What do you think?

@eclare108213
Copy link
Contributor Author

I don't think we should be examples. That might be confusing because of the other entries in which a particular string is required. And the default files are full of examples! In general, I think it's fine to leave it generic ('integer', 'string', etc) in the documentation unless there are specific choices, and then put those in the table.

@duvivier duvivier mentioned this issue Nov 1, 2018
@duvivier
Copy link
Contributor

duvivier commented Nov 5, 2018

Completed with PR #225 and #227

@duvivier duvivier closed this as completed Nov 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants