Skip to content

Commit

Permalink
add more exported functions to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rfourquet committed May 11, 2019
1 parent a658585 commit 6f318ae
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ julia> ans[1:4]
<1011>
```

Currently, the following functions are exported: `bit`, `bits`, `bitsize`, `mask`, `masked`, `tstbit`.
Currently, the following functions are exported:
`bit`, `bits`, `bitsize`, `low0`, `low1`, `mask`, `masked`, `scan0`, `scan1`, `tstbit`, `weight`.
They have a docstring, but no HTML documentation is available yet.

In these functions, the right-most bit of a value has index `1`, but in some applications it's more natural for it to have index `0`.
Expand Down
3 changes: 1 addition & 2 deletions src/Bits.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

module Bits

export bitsize, bits, bit, tstbit, mask, masked, weight, scan0, scan1, low0, low1

export bit, bits, bitsize, low0, low1, mask, masked, scan0, scan1, tstbit, weight
using Base: BitInteger, BitIntegerType


Expand Down

2 comments on commit 6f318ae

@rfourquet
Copy link
Owner Author

Choose a reason for hiding this comment

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

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/679

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if Julia TagBot is installed, or can be done manually through the github interface, or via:

git tag -a v0.2.0 -m "<description of version>" 6f318aea5511359d190912f863dcf177a3a2ddb1
git push origin v0.2.0

Please sign in to comment.