amrex icon indicating copy to clipboard operation
amrex copied to clipboard

Add doc page with input parameters and descriptions

Open etpalmer63 opened this issue 2 years ago • 2 comments

Summary

List of input parameters that relate to plotfile output.

Additional background

Checklist

The proposed changes:

  • [ ] fix a bug or incorrect behavior in AMReX
  • [ ] add new capabilities to AMReX
  • [ ] changes answers in the test suite to more than roundoff level
  • [ ] are likely to significantly affect the results of downstream AMReX users
  • [x] include documentation in the code and/or rst files, if appropriate

etpalmer63 avatar May 17 '22 18:05 etpalmer63

A couple input parameter descriptions are incomplete and some may been inaccurate. I am happy to have help from others for the description entries.

etpalmer63 avatar May 17 '22 18:05 etpalmer63

I see this PR as having two issues after reviving it:

  1. It's not part of the table of contents and I don't believe any page in the document currently link to it. So it won't be easy for users to find.
  2. The information may be out of date and should be re-verified.

Thanks!

Erik

etpalmer63 avatar Aug 25 '23 15:08 etpalmer63