Skip to content

Commit

Permalink
docs(example.py): add links to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Elijas committed Dec 22, 2023
1 parent dd9f9f8 commit bd19051
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions .devcontainer/example.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down

0 comments on commit bd19051

Please sign in to comment.