From 0066f4d65b6b9e8806f07aad6e6dac8bf957f3db Mon Sep 17 00:00:00 2001 From: Hajime Senuma Date: Mon, 27 Jan 2025 00:06:32 +0900 Subject: [PATCH] Fix documents (#122) --- README.md | 4 ++-- docs/api.md | 2 +- pyproject.toml | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1245e7a..76f9d16 100644 --- a/README.md +++ b/README.md @@ -266,8 +266,8 @@ is useful for OSINT and cybersecurity activities. ## How to Cite This Library -If you use this library in your research, it would be much appreciated it if -you would cite the following paper published in the +If you use this library in your research, it would be appreciated if you could +cite the following paper published in the [_Journal of Open Source Software_](https://joss.theoj.org): Hajime Senuma. 2025. diff --git a/docs/api.md b/docs/api.md index b138c1f..d0dd0cf 100644 --- a/docs/api.md +++ b/docs/api.md @@ -27,7 +27,7 @@ functions particularly useful: Note that **`mmh3` is endian-neutral**, while the original C++ library is endian-sensitive (see also -[Known Issues](https://github.com/hajimes/mmh3#known-issues)). +[Frequently Asked Questions](https://github.com/hajimes/mmh3#frequently-asked-questions)). This feature of `mmh3` is essential when portability across different architectures is required, such as when calculating hash footprints for web services. diff --git a/pyproject.toml b/pyproject.toml index e8578c0..0e40443 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta" [project] name = "mmh3" -version = "5.1.0" +version = "5.1.1-dev.1" description = "Python extension for MurmurHash (MurmurHash3), a set of fast and robust hash functions." readme = "README.md" license = {file = "LICENSE"}