Skip to content

Commit

Permalink
Removed unnecessary links to load(), stream(), save() and `appe…
Browse files Browse the repository at this point in the history
…nd()` in the README file
  • Loading branch information
umarbutler committed Nov 19, 2022
1 parent e9b5a15 commit 4de8ff7
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 5 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.1.3] - 2022-11-20

### Changed

- Removed unnecessary links to `load()`, `stream()`, `save()` and `append()` in the README file.

## [0.1.2] - 2022-11-20

### Added
Expand Down Expand Up @@ -34,6 +40,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
- Added the `save()` function, which serializes an iterable of Python objects to a UTF-8-encoded jsonl file.
- Added the `append()` function, serializes and appends an iterable of Python objects to a UTF-8-encoded jsonl file.

[0.1.3]: https://github.com/umarbutler/orjsonl/compare/v0.1.2...v0.1.3
[0.1.2]: https://github.com/umarbutler/orjsonl/compare/v0.1.1...v0.1.2
[0.1.1]: https://github.com/umarbutler/orjsonl/compare/v0.1.0...v0.1.1
[0.1.0]: https://github.com/umarbutler/orjsonl/releases/tag/v0.1.0
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def load(
) -> list[dict | list | int | float | str | bool | None]: ...
```

[`load()`](#load) deserializes a UTF-8-encoded jsonl file to a list of Python objects.
`load()` deserializes a UTF-8-encoded jsonl file to a list of Python objects.

`path` is a path-like object giving the pathname (absolute or relative to the current working directory), or an integer file descriptor, of the jsonl file to be deserialized.

Expand All @@ -55,7 +55,7 @@ def stream(
) -> map: ...
```

[`stream()`](#stream) creates a `map` object that deserializes a UTF-8-encoded jsonl file to Python objects.
`stream()` creates a `map` object that deserializes a UTF-8-encoded jsonl file to Python objects.

`path` is a path-like object giving the pathname (absolute or relative to the current working directory), or an integer file descriptor, of the jsonl file to be deserialized by the `map` object.

Expand All @@ -72,7 +72,7 @@ def save(
) -> None: ...
```

[`save()`](#save) serializes an iterable of Python objects to a UTF-8-encoded jsonl file.
`save()` serializes an iterable of Python objects to a UTF-8-encoded jsonl file.

`path` is a path-like object giving the pathname (absolute or relative to the current working directory), or an integer file descriptor, of the jsonl file to be saved.

Expand All @@ -94,7 +94,7 @@ def append(
) -> None: ...
```

[`append()`](#append) serializes and appends an iterable of Python objects to a UTF-8-encoded jsonl file.
`append()` serializes and appends an iterable of Python objects to a UTF-8-encoded jsonl file.

`path` is a path-like object giving the pathname (absolute or relative to the current working directory), or an integer file descriptor, of the jsonl file to be appended.

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "hatchling.build"

[project]
name = "orjsonl"
version = "0.1.2"
version = "0.1.3"
authors = [
{name="Umar Butler", email="[email protected]"},
]
Expand Down

0 comments on commit 4de8ff7

Please sign in to comment.