Skip to content

Commit

Permalink
Misc minor changes
Browse files Browse the repository at this point in the history
  • Loading branch information
jakobnissen committed Jun 24, 2024
1 parent 13141c8 commit 28ac626
Show file tree
Hide file tree
Showing 5 changed files with 184 additions and 26 deletions.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Thank you for making an issue.
If you are submitting a bug report, it will help us if you include the following information:

- Your version of Julia and all packages in your activated Julia environment
- A small example that demonstrates the bug. If possible, please make the code copy-pastable into a fresh REPL.
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Thank you for your contribution!
If you have any questions about your PR, or need help completing it, you can ping the maintainers of this repository, who will be happy to help if they can find time.

You can optionally use the following checklist when you work on your PR:
- [ ] I have updated any relevant documentation and docstrings.
- [ ] I have added unit tests, and the CodeCov bot shows tests cover my new code.
- [ ] I have mentioned my changes in the CHANGELOG.md file.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
This package implements `MemView`, a simple, low-level view into a chunk of `Memory`, as well as the `MemKind` trait to guide dispatch of generic methods to memory views.
It is intended to be used as a foundational base for other packages.

To learn how to use the package, [read the documentation](https://biojulia.github.io/MemViews.jl/stable/)
To learn how to use the package, [read the documentation](https://biojulia.github.io/MemViews.jl/dev/)

## Example
### Basic usage
Expand Down Expand Up @@ -76,3 +76,6 @@ foo(x::AbstractString) = foo(codeunits(x))
requires heap-allocating a new `Memory` pointing to the existing memory of the string.
This can be fixed if `String` is re-implemented to be backed by `Memory`, but I don't know
enough details about the implementation of `String` to know if this is practical.

## Contributing
Make an issue or PR on this repository, or get in touch with the BioJulia community over at the [Julia Slack](https://julialang.org/slack/) or Zulip servers.
2 changes: 1 addition & 1 deletion src/MemViews.jl
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ struct MemView{T, M <: Union{Mutable, Immutable}} <: DenseVector{T}
len::Int

function MemView{T, M}(::Unsafe, ref::MemoryRef{T}, len::Int) where {T, M}
M == Union{} && error("Parameter M must be Mutable or Immutable")
(M === Mutable || M === Immutable) || error("Parameter M must be Mutable or Immutable")
new{T, M}(ref, len)
end
end
Expand Down
191 changes: 167 additions & 24 deletions sticker.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 28ac626

Please sign in to comment.