Skip to content

Conversation

@PhRosenberger
Copy link
Contributor

Reference to a related issue in the repository

This PR solves #362 as unit-writing is now corrected.

Add a description

Corrects writing of units without brackets in whole docu.

Mention a member

@jdsika could you please double-check?

Check the checklist

  • My code and comments follow the style guidelines and contributors guidelines of this project.
  • I have performed a self-review of my own code.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests / travis ci pass locally with my changes.

@PhRosenberger PhRosenberger requested a review from jdsika January 14, 2020 09:51
@PhRosenberger PhRosenberger added Documentation Everything which impacts the quality of the documentation and guidelines. Quality Quality improvements. labels Jan 14, 2020
@jdsika jdsika added this to the v3.1.3 milestone Jan 14, 2020
Copy link
Contributor

@jdsika jdsika left a comment

Choose a reason for hiding this comment

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

LGTM

@jdsika
Copy link
Contributor

jdsika commented Jan 14, 2020

@vkresch could we add a test for this?

@vkresch
Copy link
Contributor

vkresch commented Jan 14, 2020

@jdsika yes we could define all available units in a list and then check for each found unit if brackets exist. If a unit is found and no brackets around it are detected (or detect just white space) the test passes. Not sure how big of a task would be defining the list. Maybe we just define for now all available units in OSI and add them later on as we go. Something like this:
['m', 'm/s', 'Pa', 'bar', ...]

@jdsika
Copy link
Contributor

jdsika commented Jan 14, 2020

I will merge for now and we may add the tests later - let it sink in a little bit

@jdsika jdsika merged commit 8aff9ad into master Jan 14, 2020
@vkresch vkresch mentioned this pull request Jan 17, 2020
6 tasks
@pmai pmai deleted the documentation/units-not-in-brackets branch April 27, 2020 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Everything which impacts the quality of the documentation and guidelines. Quality Quality improvements.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants