Loading docs/source/contributing.rst +5 −5 Original line number Diff line number Diff line Loading @@ -111,11 +111,11 @@ New features should add a corresponding documentation in /docs. An editor compatible with `EditorConfig <https://editorconfig.org/>`_ will help you to follow the general formatting code style. Timestamps must be in UTC. It is prefered to use ``datetime`` objects or Timestamps must be in UTC. It is preferred to use ``datetime`` objects or Unix timestamps. Timestamps read by the user should be always formatted in `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_ Functional style is prefered: Functional style is preferred: - use list comprenhensions lambda, map, reduce - avoid reasigigning variables, instead create new ones Loading Loading @@ -148,7 +148,7 @@ and possibly the bugfix version. The commit message should contain ``Closes: #bugnumber``. From version 1.0.2 we started to prefix the summary with the subpackage or component, though we have not standarized the words to use, eg: ``scanner``, component, though we have not standardized the words to use, eg: ``scanner``, ``generate``, ``v3bwfile``, ``relaylist``, ``doc``, ``test``, ``CI``. From version 1.0.3, we also started to prefix the summary with ``new``, Loading @@ -156,7 +156,7 @@ From version 1.0.3, we also started to prefix the summary with ``new``, sections in the CHANGELOG. From version 1.1.0 we started to use the words ``new``, ``chg`` and ``fix``, not in the sense `gitchangelog`_ use them, but to match sematic versioning not in the sense `gitchangelog`_ use them, but to match semantic versioning changes major, minor and patch. Try to make each commit a logically separate changes.:: Loading Loading @@ -313,7 +313,7 @@ Example commit message between, but conventions vary here .. rubric:: External eferences .. rubric:: External references .. [DIST] https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project .. [MERG] https://www.atlassian.com/git/tutorials/merging-vs-rebasing Loading docs/source/examples/sbws.example.ini +1 −1 Original line number Diff line number Diff line Loading @@ -30,7 +30,7 @@ country = ZZ max_num_failures = 3 ## The following logging options are set by default. ## There is no need to change them unless other options are prefered. ## There is no need to change them unless other options are preferred. ; [logging] ; # Whether or not to log to a rotating file the directory paths.log_dname ; to_file = yes Loading docs/source/generator.rst +3 −3 Original line number Diff line number Diff line Loading @@ -23,15 +23,15 @@ Each relay bandwidth measurements are selected in the following way: #. At least two bandwidth measurements (``Result`` s) MUST have been obtained within an arbitrary number of seconds (currently one day). If they are not, the relay MUST NOT be included in the Bandwith File. #. The measurements than are are older than an arbitrary number of senconds If they are not, the relay MUST NOT be included in the Bandwidth File. #. The measurements than are are older than an arbitrary number of seconds in the past MUST be discarded. Currently this number is the same as ``data_period`` (5 days) when not scaling as Torflow and 28 days when scaling as Torflow. If the number of relays to include in the Bandwidth File are less than a percententage (currently 60%) than the number of relays in the consensus, additional Header Lines MUST be added (see XXX) to the Bandwith File and the additional Header Lines MUST be added (see XXX) to the Bandwidth File and the relays SHOULD NOT be included. .. image:: ./images/activity_aggr_file.svg Loading docs/source/glossary.rst +2 −2 Original line number Diff line number Diff line Loading @@ -20,7 +20,7 @@ Glossary generator Term to refer to the tool that generates the :term:`bandwidth list file` s. Often used as a synomym for :term:`bandwidth list file` s. Often used as a synonym for :term:`scanner`. bandwidth list file Loading @@ -44,6 +44,6 @@ Glossary destination The term used by ``sbws`` to refer to a Web server where the :term:`scanner` request files to perform the bandwith measurements. :term:`scanner` request files to perform the bandwidth measurements. .. [#] https://metrics.torproject.org/glossary.html docs/source/how_works.rst +1 −1 Original line number Diff line number Diff line Loading @@ -26,7 +26,7 @@ by a :term:`directory authority` to report relays’ bandwidth in its vote. .. image:: ./images/dirauths_bwauths.png Intialization Initialization -------------- .. At some point it should be able to get environment variables Loading Loading
docs/source/contributing.rst +5 −5 Original line number Diff line number Diff line Loading @@ -111,11 +111,11 @@ New features should add a corresponding documentation in /docs. An editor compatible with `EditorConfig <https://editorconfig.org/>`_ will help you to follow the general formatting code style. Timestamps must be in UTC. It is prefered to use ``datetime`` objects or Timestamps must be in UTC. It is preferred to use ``datetime`` objects or Unix timestamps. Timestamps read by the user should be always formatted in `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_ Functional style is prefered: Functional style is preferred: - use list comprenhensions lambda, map, reduce - avoid reasigigning variables, instead create new ones Loading Loading @@ -148,7 +148,7 @@ and possibly the bugfix version. The commit message should contain ``Closes: #bugnumber``. From version 1.0.2 we started to prefix the summary with the subpackage or component, though we have not standarized the words to use, eg: ``scanner``, component, though we have not standardized the words to use, eg: ``scanner``, ``generate``, ``v3bwfile``, ``relaylist``, ``doc``, ``test``, ``CI``. From version 1.0.3, we also started to prefix the summary with ``new``, Loading @@ -156,7 +156,7 @@ From version 1.0.3, we also started to prefix the summary with ``new``, sections in the CHANGELOG. From version 1.1.0 we started to use the words ``new``, ``chg`` and ``fix``, not in the sense `gitchangelog`_ use them, but to match sematic versioning not in the sense `gitchangelog`_ use them, but to match semantic versioning changes major, minor and patch. Try to make each commit a logically separate changes.:: Loading Loading @@ -313,7 +313,7 @@ Example commit message between, but conventions vary here .. rubric:: External eferences .. rubric:: External references .. [DIST] https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project .. [MERG] https://www.atlassian.com/git/tutorials/merging-vs-rebasing Loading
docs/source/examples/sbws.example.ini +1 −1 Original line number Diff line number Diff line Loading @@ -30,7 +30,7 @@ country = ZZ max_num_failures = 3 ## The following logging options are set by default. ## There is no need to change them unless other options are prefered. ## There is no need to change them unless other options are preferred. ; [logging] ; # Whether or not to log to a rotating file the directory paths.log_dname ; to_file = yes Loading
docs/source/generator.rst +3 −3 Original line number Diff line number Diff line Loading @@ -23,15 +23,15 @@ Each relay bandwidth measurements are selected in the following way: #. At least two bandwidth measurements (``Result`` s) MUST have been obtained within an arbitrary number of seconds (currently one day). If they are not, the relay MUST NOT be included in the Bandwith File. #. The measurements than are are older than an arbitrary number of senconds If they are not, the relay MUST NOT be included in the Bandwidth File. #. The measurements than are are older than an arbitrary number of seconds in the past MUST be discarded. Currently this number is the same as ``data_period`` (5 days) when not scaling as Torflow and 28 days when scaling as Torflow. If the number of relays to include in the Bandwidth File are less than a percententage (currently 60%) than the number of relays in the consensus, additional Header Lines MUST be added (see XXX) to the Bandwith File and the additional Header Lines MUST be added (see XXX) to the Bandwidth File and the relays SHOULD NOT be included. .. image:: ./images/activity_aggr_file.svg Loading
docs/source/glossary.rst +2 −2 Original line number Diff line number Diff line Loading @@ -20,7 +20,7 @@ Glossary generator Term to refer to the tool that generates the :term:`bandwidth list file` s. Often used as a synomym for :term:`bandwidth list file` s. Often used as a synonym for :term:`scanner`. bandwidth list file Loading @@ -44,6 +44,6 @@ Glossary destination The term used by ``sbws`` to refer to a Web server where the :term:`scanner` request files to perform the bandwith measurements. :term:`scanner` request files to perform the bandwidth measurements. .. [#] https://metrics.torproject.org/glossary.html
docs/source/how_works.rst +1 −1 Original line number Diff line number Diff line Loading @@ -26,7 +26,7 @@ by a :term:`directory authority` to report relays’ bandwidth in its vote. .. image:: ./images/dirauths_bwauths.png Intialization Initialization -------------- .. At some point it should be able to get environment variables Loading