From bd1905118560e188568831b3c0e902de2ccf3c24 Mon Sep 17 00:00:00 2001 From: Elijas <4084885+Elijas@users.noreply.github.com> Date: Fri, 22 Dec 2023 10:34:10 +0200 Subject: [PATCH] docs(example.py): add links to documentation --- .devcontainer/example.py | 6 ++++++ README.md | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/.devcontainer/example.py b/.devcontainer/example.py index 9700b62..14c2090 100644 --- a/.devcontainer/example.py +++ b/.devcontainer/example.py @@ -1,3 +1,9 @@ +# NOTE: +# For more examples and advanced usage of `sec-parser`, refer to the following resources: +# - [User Guide](https://sec-parser.readthedocs.io/en/latest/notebooks/user_guide.html) +# - [Developer Guide](https://sec-parser.readthedocs.io/en/latest/notebooks/developer_guide.html) +# - [Documentation](https://sec-parser.rtfd.io) + from sec_downloader import Downloader import sec_parser as sp diff --git a/README.md b/README.md index 8930505..d572c72 100644 --- a/README.md +++ b/README.md @@ -143,7 +143,7 @@ The company name and email address are used to form a user-agent string that adh Now, we can parse the filing HTML into a list of semantic elements: -```python +```python`` # Utility function to make the example code a bit more compact def print_first_n_lines(text: str, *, n: int): print("\n".join(text.split("\n")[:n]), "...", sep="\n")