diff --git a/addons/source-python/docs/source-python/source/conf.py b/addons/source-python/docs/source-python/source/conf.py index 0aeb58fd4..74d0b2b28 100644 --- a/addons/source-python/docs/source-python/source/conf.py +++ b/addons/source-python/docs/source-python/source/conf.py @@ -16,6 +16,7 @@ import sys import os import shlex +from datetime import date # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -53,7 +54,7 @@ # General information about the project. project = ' Source.Python' -copyright = '2018, Source.Python Development Team' +copyright = f'{date.today().year}, Source.Python Development Team' author = ' Source.Python Development Team' # The version info for the project you're documenting, acts as replacement for diff --git a/addons/source-python/docs/source-python/source/contributing/building.rst b/addons/source-python/docs/source-python/source/contributing/building.rst index 6fd934f7f..f92ea911f 100644 --- a/addons/source-python/docs/source-python/source/contributing/building.rst +++ b/addons/source-python/docs/source-python/source/contributing/building.rst @@ -29,7 +29,7 @@ Once you have installed the requirements, follow these steps to build Source.Pyt By default only one CPU core is used to build the binaries. If you wish to use more, set the variable ``NUM_CORES`` to the number of core you would like to use. This will speed up the build process, but also requires more - ressoures. + resources. You can shorten these steps by simply passing the game's name to the script e.g. ``./Build.sh css``. diff --git a/addons/source-python/docs/source-python/source/developing/events/csgo.rst b/addons/source-python/docs/source-python/source/developing/events/csgo.rst index 7ff1d07af..e8448b8fc 100644 --- a/addons/source-python/docs/source-python/source/developing/events/csgo.rst +++ b/addons/source-python/docs/source-python/source/developing/events/csgo.rst @@ -1593,12 +1593,16 @@ avenger_id The userid of the player that killed their teammate's killer. player_blind ------------ - -====== ==================================================== ======= -Name Description Type -====== ==================================================== ======= -userid short -====== ==================================================== ======= +This event is fired when a player gets flashed. + +============== ================================================== ===== +Name Description Type +============== ================================================== ===== +userid The userid of the player that got flashed. short +attacker The userid of the player that threw the flashbang. short +entityid The entity index of the flashbang that went off. short +blind_duration Duration of the flashed effect. float +============== ================================================== ===== player_changename diff --git a/addons/source-python/docs/source-python/source/developing/getting-started.rst b/addons/source-python/docs/source-python/source/developing/getting-started.rst index 43c8c5612..9dd6c3e09 100644 --- a/addons/source-python/docs/source-python/source/developing/getting-started.rst +++ b/addons/source-python/docs/source-python/source/developing/getting-started.rst @@ -20,7 +20,7 @@ have to create the plugin files. To do so, please create a directory in Source.Python's plugin directory (``../addons/source-python/plugins``). All plugins will be located in this directory and must have their own sub-directory. Give the new created -directory an abitrary name (e.g. test1). Now, you need to create the actual +directory an arbitrary name (e.g. test1). Now, you need to create the actual plugin file. It must be named like its directory. So, if you have created a ``test1`` directory, you have to create a ``test1.py`` in that directory. diff --git a/addons/source-python/docs/source-python/source/developing/module_tutorials/listeners.rst b/addons/source-python/docs/source-python/source/developing/module_tutorials/listeners.rst index 9cf0fdb27..761060140 100644 --- a/addons/source-python/docs/source-python/source/developing/module_tutorials/listeners.rst +++ b/addons/source-python/docs/source-python/source/developing/module_tutorials/listeners.rst @@ -452,7 +452,7 @@ file exists, etc.) have been done at this point. OnPluginUnloaded ---------------- -Called when a plugin has been unloaded sucessfully. +Called when a plugin has been unloaded successfully. .. code-block:: python diff --git a/addons/source-python/docs/source-python/source/developing/module_tutorials/plugins.rst b/addons/source-python/docs/source-python/source/developing/module_tutorials/plugins.rst index d68fdb8dd..6fe5efdf7 100644 --- a/addons/source-python/docs/source-python/source/developing/module_tutorials/plugins.rst +++ b/addons/source-python/docs/source-python/source/developing/module_tutorials/plugins.rst @@ -158,7 +158,7 @@ Adding sub-plugins Adding sub-plugins to your plugin is done a very few steps. All you actually need is a new instance of the :class:`plugins.manager.PluginManager` class. -This instance allows you to load plugins from a specifc directory. +This instance allows you to load plugins from a specific directory. Imagine your plugin resides in ``../addons/source-python/plugins/my_plugin`` and within that directory you have created a new directory called ``plugins``, diff --git a/addons/source-python/docs/source-python/source/general/reporting-a-bug.rst b/addons/source-python/docs/source-python/source/general/reporting-a-bug.rst index de5cdb22c..317636bb3 100644 --- a/addons/source-python/docs/source-python/source/general/reporting-a-bug.rst +++ b/addons/source-python/docs/source-python/source/general/reporting-a-bug.rst @@ -7,7 +7,7 @@ us, because it helps to improve Source.Python. We prefer bugs to be reported via When reporting a bug, please consider the following points: -1. Precisly describe your problem. +1. Precisely describe your problem. 2. Provide the output of the server command ``sp info``. 3. Post your SP log file. 4. If your server crashes, add ``-debug`` to your command line and post the resulting ``debug.log``. diff --git a/addons/source-python/docs/source-python/source/index.rst b/addons/source-python/docs/source-python/source/index.rst index ea9fef984..50f57ec17 100644 --- a/addons/source-python/docs/source-python/source/index.rst +++ b/addons/source-python/docs/source-python/source/index.rst @@ -7,7 +7,7 @@ Source.Python is an open-source project that uses Boost.Python to allow scripters to interact with Valve's Source-engine. In this wiki, you will find documentation on how to install, update, and use Source.Python. If you have any questions, please search for an answer on our -`forums `_. If you cannot find the +`forums `_. If you cannot find the answer to your question, please post a question of your own in the appropriate forum. @@ -67,9 +67,9 @@ Other helpful links ------------------- * Source.Python - * `Source.Python forums `_ - * `Source.Python repository `_ - * `Source.Python issue list `_ + * `Source.Python forums `_ + * `Source.Python repository `_ + * `Source.Python issue list `_ * Python 3