Documentation improvements - Githubissues

nholthaus / units

a compile-time, header-only, dimensional analysis and unit conversion library built on c++14 with no dependencies.

http://nholthaus.github.io/units/

MIT License

947 stars 135 forks source link

Documentation improvements #189

Closed JohelEGP closed 5 years ago

JohelEGP commented 5 years ago

Mostly removes uses of the word container in unit containers and updates code/comments based on conversion_factor renaming.
Renames is_convertible_conversion_factor to is_same_dimension as per https://github.com/nholthaus/units/issues/185#issuecomment-423004260.
Adds store_linear_value_t tag type, as per https://github.com/nholthaus/units/issues/185#issuecomment-423350563. unit still forwards extra arguments to the scale, but units' scales now only know about store_linear_value_t.

JohelEGP commented 5 years ago

Note that the CI fail above was due to Travis' spuriously errored jobs and doesn't have anything to do with the following commit.

nholthaus commented 5 years ago

@johelegp changes look good but probably better if you rebase this than me.

JohelEGP commented 5 years ago

Rebased. Looks like df698c8 didn't work with Clang 5 as used in Travis.

nholthaus commented 5 years ago

yeah that looks like a clang bug to me, but meh, I'll just give it an initializer in another commit. I really want to get the renaming done so we cut down on our merge conflicts. It's sort of arbitrary but I have a desire to put out a beta release end of next week.

JohelEGP commented 5 years ago

But then it wouldn't test what it's supposed to ;)

nholthaus commented 5 years ago

yeah I know, but I know in my heart that it works :)

JohelEGP commented 5 years ago

I really want to get the renaming done so we cut down on our merge conflicts. It's sort of arbitrary but I have a desire to put out a beta release end of next week.

Looking forward to that.