documentation fixes and improvements

TabulateJarl8 · Feb 22, 2023 · 518d119 · 518d119
1 parent 781856b
commit 518d119
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ $ pip3 install randfacts
 
 Via your AUR helper, like paru:
 ```sh
-paru -S python-randfacts
+$ paru -S python-randfacts
 ```
 
 Or manually
@@ -45,7 +45,7 @@ import randfacts
 x = randfacts.get_fact()
 print(x)
 ```
-will print a random fact like:
+The above example will print a random fact like:
 `Penguins can't taste sweet or savory flavors, only sour and salty ones`
 
 This package has a filter option to filter out potentially inappropriate facts. The filter is on by default. To disable the filter, you can just set the `filter_enabled` parameter to `False`.
@@ -69,19 +69,19 @@ If you want to access the list of facts directly, you can just import the `safe_
 
 randfacts can be executed via the command line with the following commands:
 
-Normal execution; only safe facts
+Normal execution; only SFW (safe for work) facts
 
 ```sh
 $ python3 -m randfacts
 ```
 
-The unsafe argument can be supplied to provide only unsafe facts
+The unsafe argument can be supplied to provide only NSFW (not safe for work) facts
 
 ```sh
 $ python3 -m randfacts --unsafe
 ```
 
-The mixed argument can be provided to provide both safe and unsafe facts.
+The mixed argument can be provided to provide both SFW and NSFW facts.
 
 ```sh
 $ python3 -m randfacts --mixed

diff --git a/randfacts/__init__.py b/randfacts/__init__.py
@@ -1,21 +1,21 @@
 """Module to generate random facts.
 
 randfacts provides an interface to a list of facts installed with the module.
-You can retrieve facts via the getFact method. randfacts also allows for
+You can retrieve facts via the get_fact method. randfacts also allows for
 execution via the command line. See the examples section for more details.
 
 Code Examples:
 		Example usage of randfacts in code.
 
-		Generate a random safe fact.
+		Generate a random SFW (safe for work) fact.
 
 			>>> randfacts.get_fact()
 
-		Generate a random unsafe fact.
+		Generate a random NSFW (not safe for work) fact.
 
 			>>> randfacts.get_fact(only_unsafe=True)
 
-		Generate a random mixed fact (possibility of both safe and unsafe facts)
+		Generate a random mixed fact (possibility of both SFW and NSFW facts)
 
 			>>> randfacts.get_fact(False)
 			>>> # or
@@ -32,7 +32,7 @@
 
 		$ python3 -m randfacts --unsafe
 
-	The mixed argument can be provided to provide both safe and unsafe facts.
+	The mixed argument can be provided to provide both SFW and NSFW facts.
 
 		$ python3 -m randfacts --mixed
 

diff --git a/randfacts/__version__.py b/randfacts/__version__.py
@@ -1,8 +1,8 @@
 __title__ = "randfacts"
 __description__ = "Package to generate random facts"
 __url__ = "https://github.com/TabulateJarl8/randfacts"
-__version__ = "0.20.0"
+__version__ = "0.20.1"
 __author__ = "Tabulate"
 __author_email__ = "[email protected]"
 __license__ = "MIT"
-__copyright__ = "Copyright 2020-2021 Connor Sample"
+__copyright__ = "Copyright 2020-2023 Connor Sample"
diff --git a/randfacts/randfacts.py b/randfacts/randfacts.py
@@ -32,7 +32,7 @@ def get_fact(filter_enabled: bool = True, only_unsafe: bool = False) -> str:
 
 	only_unsafe : bool
 		The `only_unsafe` parameter determines if the function will only give
-		unsafe facts. Takes precedence over the `filter_enabled` argument.
+		unsafe (NSFW) facts. Takes precedence over the `filter_enabled` argument.
 
 	Returns
 	------

diff --git a/setup.py b/setup.py
@@ -30,6 +30,7 @@
 		"Programming Language :: Python :: 3.8",
 		"Programming Language :: Python :: 3.9",
 		"Programming Language :: Python :: 3.10",
+		"Programming Language :: Python :: 3.11",
 		"Natural Language :: English",
 		"License :: OSI Approved :: MIT License",
 		"Operating System :: OS Independent",