Skip to content

Commit

Permalink
fix module docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
TabulateJarl8 committed Nov 18, 2024
1 parent 172731d commit 0a2c930
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions randfacts/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,16 @@
Code Examples:
Example usage of randfacts in code.
generate a random sfw (safe for work) fact.
Generate a random SFW (safe for work) fact.
>>> randfacts.get_fact()
generate a random nsfw (not safe for work) fact.
Generate a random NSFW (not safe for work) fact.
>>> randfacts.get_fact(only_unsafe=true)
>>> randfacts.get_fact(only_unsafe=True)
generate a random mixed fact (possibility of both sfw and nsfw facts)
Generate a random mixed fact (possibility of both SFW and NSFW facts)
>>> randfacts.get_fact(false)
>>> # or
>>> randfacts.get_fact(filter_enabled=False)
CLI Examples:
Expand Down

0 comments on commit 0a2c930

Please sign in to comment.