Skip to content

Commit

Permalink
add docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
rprimet committed Feb 16, 2024
1 parent 0930ae0 commit f3e3692
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/catleg/skeleton.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@ async def markdown_skeleton(textid: str, sectionid: str) -> str:
async def article_skeleton(articleid: str, breadcrumbs: bool = True) -> str:
"""
Return an article skeleton (markdown-formatted law article).
Parameters
----------
articleid: str
Legifrance article identifier
breadcrumbs: bool
if True, emits breadcrumbs (table of contents headers) before
outputting the article itself
Returns
-------
str
Markdown-formatted article
"""
back = get_backend("legifrance")
# This uses the Legifrance API directly, not the backend abstraction
Expand Down

0 comments on commit f3e3692

Please sign in to comment.