doc: reword documentation

Author: null8626

README.md

@@ -11,47 +11,53 @@
 
 A free and asynchronous weather Python API wrapper made in Python, for Python.
 
-## Installation
+## Getting started
+
+Run the following command in your terminal:
 
 ```console
-pip install python-weather
+$ pip install python-weather
 ```
 
 ## Example
 
 For more information, please read the [documentation](https://python-weather.readthedocs.io/en/latest/).
 
 ```py
-# import the module
+# Import the module.
 import python_weather
 
 import asyncio
 import os
 
-async def getweather() -> None:
-  # declare the client. the measuring unit used defaults to the metric system (celcius, km/h, etc.)
+
+async def main() -> None:
+  
+  # Declare the client. The measuring unit used defaults to the metric system (celcius, km/h, etc.)
   async with python_weather.Client(unit=python_weather.IMPERIAL) as client:
-    # fetch a weather forecast from a city
+    
+    # Fetch a weather forecast from a city.
     weather = await client.get('New York')
 
-    # returns the current day's forecast temperature (int)
+    # Fetch the temperature for today.
     print(weather.temperature)
 
-    # get the weather forecast for a few days
+    # Fetch weather forecast for upcoming days.
     for daily in weather:
       print(daily)
-      
-      # hourly forecasts
+    
+      # Each daily forecast has their own hourly forecasts.
       for hourly in daily:
         print(f' --> {hourly!r}')
 
 if __name__ == '__main__':
-  # see https://stackoverflow.com/questions/45600579/asyncio-event-loop-is-closed-when-getting-loop
-  # for more details
+  
+  # See https://stackoverflow.com/questions/45600579/asyncio-event-loop-is-closed-when-getting-loop
+  # for more details.
   if os.name == 'nt':
     asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
 
-  asyncio.run(getweather())
+  asyncio.run(main())
 ```
 
 ## Data source

docs/changelog.py

@@ -4,7 +4,7 @@
 
 
 class Row:
-  __slots__: Tuple[str, ...] = ('header_name', 'rows', 'character_length')
+  __slots__: tuple[str, ...] = ('header_name', 'rows', 'character_length')
 
   def __init__(self, header_name: str):
     self.header_name = header_name
@@ -25,7 +25,7 @@ def render(self, text: str) -> str:
 CHANGE_EMOJIS = {'add': chr(129001), 'fix': chr(128998), 'rem': chr(128997)}
 
 
-def render_lines(rows: List[Row], character: str = '-') -> str:
+def render_lines(rows: list[Row], character: str = '-') -> str:
   output = f'+{character}'
   last_idx = len(rows) - 1
 
@@ -38,7 +38,7 @@ def render_lines(rows: List[Row], character: str = '-') -> str:
   return output
 
 
-def render_contents(rows: List[Row], idx: int) -> str:
+def render_contents(rows: list[Row], idx: int) -> str:
   max_row_lines = max(map(lambda row: len(row.rows[idx].splitlines()), rows))
   output = ''
 
@@ -57,7 +57,7 @@ def render_contents(rows: List[Row], idx: int) -> str:
   return output[:-1]
 
 
-def render(rows: List[Row]) -> str:
+def render(rows: list[Row]) -> str:
   output = f'{render_lines(rows)}\n'
 
   for row in rows:

docs/conf.py

@@ -2,21 +2,21 @@
 import os
 import re
 
+
+sys.path.insert(0, os.path.join(os.getcwd(), '..', 'python_weather'))
 sys.path.insert(0, os.path.abspath('..'))
 
+from version import VERSION
+
+
 project = 'python-weather'
 author = 'null8626'
 
 copyright = ''
 with open('../LICENSE', 'r') as f:
   copyright = re.search(r'[\d\-]+ null8626', f.read()).group()
 
-version = ''
-with open('../python_weather/__init__.py', 'r') as f:
-  version = re.search(
-    r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', f.read(), re.MULTILINE
-  ).group(1)
-
+version = VERSION
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx_reredirects']
 
 intersphinx_mapping = {

docs/index.rst

@@ -23,8 +23,10 @@ python-weather_
 
 A free and asynchronous weather Python API wrapper made in Python, for Python.
 
-Installation
-------------
+Getting started
+---------------
+
+Run the following command in your terminal:
 
 .. code-block:: console
 
@@ -35,36 +37,40 @@ Example
 
 .. code-block:: python
 
-  # import the module
+  # Import the module.
   import python_weather
   
   import asyncio
   import os
   
-  async def getweather() -> None:
-    # declare the client. the measuring unit used defaults to the metric system (celcius, km/h, etc.)
+  
+  async def main() -> None:
+
+    # Declare the client. The measuring unit used defaults to the metric system (celcius, km/h, etc.)
     async with python_weather.Client(unit=python_weather.IMPERIAL) as client:
-      # fetch a weather forecast from a city
+      
+      # Fetch a weather forecast from a city.
       weather = await client.get('New York')
       
-      # returns the current day's forecast temperature (int)
+      # Fetch the temperature for today.
       print(weather.temperature)
       
-      # get the weather forecast for a few days
+      # Fetch weather forecast for upcoming days.
       for daily in weather:
         print(daily)
       
-        # hourly forecasts
+        # Each daily forecast has their own hourly forecasts.
         for hourly in daily:
           print(f' --> {hourly!r}')
   
   if __name__ == '__main__':
-    # see https://stackoverflow.com/questions/45600579/asyncio-event-loop-is-closed-when-getting-loop
-    # for more details
+    
+    # See https://stackoverflow.com/questions/45600579/asyncio-event-loop-is-closed-when-getting-loop
+    # for more details.
     if os.name == 'nt':
       asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
     
-    asyncio.run(getweather())
+    asyncio.run(main())
 
 Data source
 ___________

python_weather/__init__.py

@@ -25,13 +25,15 @@
 from .enums import HeatIndex, Kind, Locale, Phase, UltraViolet, WindDirection
 from .constants import METRIC, IMPERIAL
 from .errors import Error, RequestError
+from .version import VERSION
 from .client import Client
 
+
 __title__ = 'python-weather'
 __author__ = 'null8626'
 __license__ = 'MIT'
 __copyright__ = 'Copyright (c) 2021-2025 null8626'
-__version__ = '2.0.7'
+__version__ = VERSION
 __all__ = (
   'METRIC',
   'IMPERIAL',
@@ -43,5 +45,6 @@
   'Locale',
   'Phase',
   'UltraViolet',
+  'VERSION',
   'WindDirection',
 )

python_weather/base.py

@@ -22,33 +22,32 @@
 SOFTWARE.
 """
 
-from typing import Tuple
-
-from .errors import Error
 from .enums import WindDirection, Kind, Locale, UltraViolet
 from .constants import _Unit
+from .errors import Error
 
 
 class CustomizableBase:
-  __slots__: Tuple[str, ...] = ('__unit', '__locale')
+  __slots__: tuple[str, ...] = ('__unit', '__locale')
 
   def __init__(self, unit: _Unit, locale: Locale):
     self.unit = unit
     self.locale = locale
 
   @property
   def unit(self) -> _Unit:
-    """The measuring unit used to display information in this object."""
+    """The measuring unit used."""
 
     return self.__unit
 
   @unit.setter
   def unit(self, to: _Unit) -> None:
     """
-    Sets the default measuring unit used to display information in this object.
+    Sets the default measuring unit used.
 
-    :param to: The new default measuring unit to be used to display information in this object. Must be either ``METRIC`` or ``IMPERIAL``.
-    :exception Error: If the ``to`` argument is not either ``METRIC`` or ``IMPERIAL``.
+    :param to: The new default measuring unit to be used.
+
+    :exception Error: ``to`` is not either ``METRIC`` or ``IMPERIAL``.
     """
 
     if not isinstance(to, _Unit):
@@ -58,18 +57,19 @@ def unit(self, to: _Unit) -> None:
 
   @property
   def locale(self) -> Locale:
-    """The localization used to display information in this object."""
+    """The localization used."""
 
     return self.__locale
 
   @locale.setter
   def locale(self, to: Locale) -> None:
     """
-    Sets the default localization used to display information in this object.
+    Sets the default localization used.
 
-    :param to: The new :class:`.Locale` to be used to display information in this object.
+    :param to: The new :class:`.Locale` to be used.
     :type to: :class:`.Locale`
-    :exception Error: If the ``to`` argument is not a part of the :class:`.Locale` enum.
+
+    :exception Error: ``to`` is not a part of the :class:`.Locale` enum.
     """
 
     if not isinstance(to, Locale):
@@ -79,7 +79,7 @@ def locale(self, to: Locale) -> None:
 
 
 class BaseForecast:
-  __slots__: Tuple[str, ...] = (
+  __slots__: tuple[str, ...] = (
     'ultraviolet',
     'humidity',
     'wind_direction',
@@ -94,7 +94,7 @@ class BaseForecast:
   )
 
   ultraviolet: UltraViolet
-  """The ultra-violet (UV) index."""
+  """The ultra-violet index."""
 
   humidity: int
   """The humidity value in percent."""
@@ -106,10 +106,10 @@ class BaseForecast:
   """The kind of the forecast."""
 
   feels_like: int
-  """What it felt like, in celcius or fahrenheit."""
+  """What it felt like in either celcius or fahrenheit."""
 
   temperature: int
-  """The temperature in either celcius or Fahrenheit."""
+  """The temperature in either celcius or fahrenheit."""
 
   precipitation: float
   """The precipitation in either millimeters or inches."""
@@ -124,7 +124,7 @@ class BaseForecast:
   """The wind speeds in either kilometers/hour or miles/hour."""
 
   description: str
-  """The description regarding the forecast. This can be localized in different languages depending on the localization used."""
+  """The description regarding the forecast depending on the localization used."""
 
   def __init__(self, json: dict, unit: _Unit, locale: Locale):
     description = (