I made a few changes to the options documentation:
1) Converted the options table into a list-table. The html result is identical, but this makes it possible to change the table without having to manually adjust column widths.
2) Changed char types in the options table to str.
3) Added some boundary related options to the table (adapted from MACH-Aero tutorials).
4) Added a short tutorial on how to use the BC option. (Thanks to @yqliaohk for the Tecplot instructions)
5) Edited the BC error output to print the actual options. (Might cause merge conflicts with #31, but I can fix those)
Closes #27
Type of change
What types of change is it?
Select the appropriate type(s) that describe this PR
[ ] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (non-backwards-compatible fix or feature)
[ ] Code style update (formatting, renaming)
[ ] Refactoring (no functional changes, no API changes)
[x] Documentation update
[ ] Maintenance update
[ ] Other (please describe)
Checklist
Put an x in the boxes that apply.
[ ] I have run flake8 and black to make sure the code adheres to PEP-8 and is consistently formatted
[ ] I have run unit and regression tests which pass locally with my changes
[ ] I have added new tests that prove my fix is effective or that my feature works
Purpose
I made a few changes to the options documentation:
1) Converted the options table into a
list-table. The html result is identical, but this makes it possible to change the table without having to manually adjust column widths. 2) Changedchartypes in the options table tostr. 3) Added some boundary related options to the table (adapted from MACH-Aero tutorials). 4) Added a short tutorial on how to use theBCoption. (Thanks to @yqliaohk for the Tecplot instructions) 5) Edited the BC error output to print the actual options. (Might cause merge conflicts with #31, but I can fix those)Closes #27
Type of change
What types of change is it? Select the appropriate type(s) that describe this PR
Checklist
Put an
xin the boxes that apply.flake8andblackto make sure the code adheres to PEP-8 and is consistently formatted