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

Updated options documentation #33

Merged
merged 8 commits into from
Nov 12, 2020
Merged

Updated options documentation #33

merged 8 commits into from
Nov 12, 2020

Conversation

sseraj
Copy link
Collaborator

@sseraj sseraj commented Nov 3, 2020

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. 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 Format update and improved exception - output handling #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)
  • 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
  • I have added necessary documentation

@sseraj sseraj requested a review from a team as a code owner November 3, 2020 02:17
Copy link
Collaborator

@joanibal joanibal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good

@sseraj sseraj merged commit 9c62b4e into mdolab:master Nov 12, 2020
@sseraj sseraj deleted the options-docs branch November 12, 2020 02:44
@sseraj sseraj mentioned this pull request Dec 8, 2020
8 tasks
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.

Document the BC option
3 participants