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

Issue #277: Add documentation for options #279

Merged
merged 8 commits into from
Oct 31, 2019
Merged

Conversation

AndrewLister-STFC
Copy link
Contributor

Description of Work

Fixes #277

Adds user documentation explaining the options.

Can be viewed here

Testing Instructions

  1. Read document and check that it makes sense.
  2. Check formatting
  3. Check for completeness

@tyronerees tyronerees self-assigned this Oct 31, 2019
tyronerees
tyronerees previously approved these changes Oct 31, 2019
Copy link
Member

@tyronerees tyronerees left a comment

Choose a reason for hiding this comment

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

I've pushed a few changes directly. I thought code inlining might be helpful to separate things in the code, but I'm not convinced by the red colour. What do you think? I'll approve, but won't merge until you've had a chance to look at it.

@AndrewLister-STFC
Copy link
Contributor Author

I've pushed a few changes directly. I thought code inlining might be helpful to separate things in the code, but I'm not convinced by the red colour. What do you think? I'll approve, but won't merge until you've had a chance to look at it.

I don't mind either. The red text with boxes do make it a bit jarring, but they highlight the key bits.
Some of the things you've changed were in quotes to show that they were strings so I can add those in again and put the inline markup on the 3 headings at the bottom which now look out of place.

Copy link
Member

@tyronerees tyronerees 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 -- thanks!

@tyronerees tyronerees merged commit ba4eb70 into master Oct 31, 2019
@tyronerees tyronerees deleted the 277-options-docs branch October 31, 2019 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation on fitbenchmarking options
2 participants