Skip to content

Commit 88dca70

Browse files
committed
docs(examples): move to folder based examples
This is done because some examples (specifially interaction ones) might want to use multiple files per example, for example to register slash commands. This could be done in the main file, however that would be stupid.
1 parent 888aade commit 88dca70

File tree

7 files changed

+4
-4
lines changed

7 files changed

+4
-4
lines changed

docs/gateway.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Gateway quickstart
99
.. hint::
1010
We recommend that you read the :ref:`Making requests` tutorial before this, as we will not explain HTTP concepts here.
1111
.. hint::
12-
The finished example can be found `here <https://github.com/nextsnake/nextcore/blob/master/examples/gateway/ping_pong.py>`__
12+
The finished example can be found `here <https://github.com/nextsnake/nextcore/tree/master/examples/gateway/ping_pong>`__
1313
.. note::
1414
We will use await at the top level here as it's easier to explain. For your own code, please use an async function.
1515

docs/http.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Making requests
77
---------------
88

99
.. hint::
10-
The finished example can be found `here <https://github.com/nextsnake/nextcore/blob/master/examples/http/get_channel.py>`__
10+
The finished example can be found `here <https://github.com/nextsnake/nextcore/tree/master/examples/http/get_channel>`__
1111
.. note::
1212
We will use await at the top level here as its easier to explain. For your own code, please use a async function.
1313

examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ So examples in the `http` directory would be for stuff in the `nextcore.http` mo
66

77
## Docs
88
Some of the examples have full tutorials in the docs.
9-
For example the [get channel example](http/get_channel.py) also has a [tutorial in the docs](https://nextcore.readthedocs.io/en/latest/http.html#making-requests)
9+
For example the [get channel example](http/get_channel) also has a [tutorial in the docs](https://nextcore.readthedocs.io/en/latest/http.html#making-requests)
1010

nextcore/http/client/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ class HTTPClient(BaseHTTPClient):
6262
**Example usage**
6363
6464
65-
.. literalinclude:: ../examples/http/get_gateway.py
65+
.. literalinclude:: ../examples/http/get_gateway/get_gateway.py
6666
:lines: 30-42
6767
:language: python
6868
:dedent: 4

0 commit comments

Comments
 (0)