Skip to content

update README to reflect compact syntax - #68

Merged
vchuravy merged 1 commit into
masterfrom
vc/readme
Jan 31, 2017
Merged

vchuravy merged 1 commit into
masterfrom
vc/readme

Conversation

@vchuravy

Copy link
Copy Markdown
Collaborator

fixes #67

@codecov-io

codecov-io commented Jan 30, 2017

Copy link
Copy Markdown

Codecov Report

Merging #68 into master will not impact coverage.

@@           Coverage Diff           @@
##           master      #68   +/-   ##
=======================================
  Coverage   82.96%   82.96%           
=======================================
  Files           4        4           
  Lines         182      182           
=======================================
  Hits          151      151           
  Misses         31       31

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7188a96...d9ba46d. Read the comment docs.

@timholy timholy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👍

Comment thread README.md Outdated
`0xff` to `1.0`. Consequently, `Normed` numbers are scaled by `2^f-1`
rather than `2^f`. The type aliases `Normed10`, `Normed12`,
`Normed14`, and `Normed16` are all based on `UInt16` and reach the
rather than `2^f`. The type aliases `N6f`10`, `N4f12`,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Stray `?

Comment thread README.md Outdated
To construct such a number, use `convert(Normed12, 1.3)`, `Normed12(1.3)`, `Normed{UInt16,12}(1.3)`, or the literal syntax
`0x14ccuf12`. The latter syntax means to construct a `Normed12` (it ends in
To construct such a number, use `convert(N4f12, 1.3)`, `N4f12(1.3)`,
`Normed{UInt16,12}(1.3)`, or the deprecated literal syntax `0x14ccuf12`.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe best to recommend reinterpret(Nf12, 0x14cc) now.

@vchuravy
vchuravy merged commit c58f4a3 into master Jan 31, 2017
@vchuravy
vchuravy deleted the vc/readme branch January 31, 2017 04:26
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.

typealiases missing?

3 participants