Skip to content

Move documentation to Github wiki #280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,18 @@ change for async use.

Breaking changes:

- Decorate async JSON-RPC methods with `@async_method` instead of `@method`.
The reason for this change is due to the typing of the decorator, async
functions return a different type (`Awaitable`) to other functions.
- Async methods should be decorated with `@async_method` instead of `@method`. The
reason is due to the _type_ of the decorated function - async functions have a
different type to other functions (`Awaitable`).

Other changes:

- Internally, replaced the Oslash dependency with
[Returns](https://github.com/dry-python/returns). Because Oslash is not meant
for production use.
- Use `Ok` instead of `Success` when returning a response. This is to avoid
confusion with the Returns library now used internally which has it's own
`Success` class. It also matches Jsonrpcclient's `Ok` type. This is not a
breaking change, `Success` will still work for now. But use `Ok` instead.
- Replaced the Oslash dependency with [Returns](https://github.com/dry-python/returns).
Oslash is not meant for production use, and doesn't work in Python 3.12.
- Use `Ok` instead of `Success` when returning a response. This is to avoid confusion
with the Returns library's `Success` class. It also matches Jsonrpcclient's `Ok` type.
This is not a breaking change, `Success` will still work for now.
- Docs moved to https://github.com/explodinglabs/jsonrpcserver/wiki

## 5.0.9 (Sep 15, 2022)

Expand Down
6 changes: 0 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,6 @@ from jsonrpcserver import method, serve, Ok, Result
def ping() -> Result:
return Ok("pong")

if __name__ == "__main__":
serve()
```

Or use `dispatch` instead of `serve`:
```python
response = dispatch('{"jsonrpc": "2.0", "method": "ping", "id": 1}')
# => '{"jsonrpc": "2.0", "result": "pong", "id": 1}'
```
Expand Down
177 changes: 0 additions & 177 deletions docs/Makefile

This file was deleted.

43 changes: 0 additions & 43 deletions docs/async.md

This file was deleted.

62 changes: 0 additions & 62 deletions docs/conf.py

This file was deleted.

Loading
Loading