Skip to content

Commit be34675

Browse files
authored
Move documentation to Github wiki (#280)
1 parent ffe8374 commit be34675

File tree

13 files changed

+15
-644
lines changed

13 files changed

+15
-644
lines changed

CHANGELOG.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,18 @@ change for async use.
77

88
Breaking changes:
99

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

1414
Other changes:
1515

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

2423
## 5.0.9 (Sep 15, 2022)
2524

README.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,6 @@ from jsonrpcserver import method, serve, Ok, Result
2222
def ping() -> Result:
2323
return Ok("pong")
2424

25-
if __name__ == "__main__":
26-
serve()
27-
```
28-
29-
Or use `dispatch` instead of `serve`:
30-
```python
3125
response = dispatch('{"jsonrpc": "2.0", "method": "ping", "id": 1}')
3226
# => '{"jsonrpc": "2.0", "result": "pong", "id": 1}'
3327
```

docs/Makefile

Lines changed: 0 additions & 177 deletions
This file was deleted.

docs/async.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

docs/conf.py

Lines changed: 0 additions & 62 deletions
This file was deleted.

0 commit comments

Comments
 (0)