diff --git a/README.asciidoc b/README.asciidoc index 09317c0cd..e2b75747d 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -67,7 +67,7 @@ message to the https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser[mailinglist] at mailto:qutebrowser@lists.qutebrowser.org[]. -There's also a https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser-announce[announce-only mailinglist] +There's also an https://lists.schokokeks.org/mailman/listinfo.cgi/qutebrowser-announce[announce-only mailinglist] at mailto:qutebrowser-announce@lists.qutebrowser.org[] (the announcements also get sent to the general qutebrowser@ list). diff --git a/doc/contributing.asciidoc b/doc/contributing.asciidoc index 1b2f4be4e..9c1b87269 100644 --- a/doc/contributing.asciidoc +++ b/doc/contributing.asciidoc @@ -39,8 +39,7 @@ pointers: * https://github.com/qutebrowser/qutebrowser/labels/easy[Issues which should be easy to solve] -* https://github.com/qutebrowser/qutebrowser/labels/component%3A%20docs[Documentation -* issues which require little/no coding] +* https://github.com/qutebrowser/qutebrowser/labels/component%3A%20docs[Documentation issues which require little/no coding] If you prefer C++ or Javascript to Python, see the relevant issues which involve work in those languages: @@ -132,7 +131,7 @@ techniques are useful to handle these: * Use `_foo` for unused parameters, with `foo` being a descriptive name. Using `_` is discouraged. -* If you think you have a good reason to suppress a message, then add the +* If you think you have a good reason to suppress a message, then add the following comment: + ---- @@ -312,7 +311,7 @@ carefully be checked. * Methods of Qt objects have certain maximum values based on their underlying C++ types. + -To avoid passing too large of a numeric parameter to a Qt function, all +To avoid passing too large of a numeric parameter to a Qt function, all numbers should be range-checked using `qutebrowser.qtutils.check_overflow`, or by other means (e.g. by setting a maximum value for a config object). @@ -442,7 +441,7 @@ Possible values: values, e.g., `typing.Union[str, int]` You can customize how an argument is handled using the `@cmdutils.argument` -decorator *after* `@cmdutils.register`. This can, for example, be used to +decorator *after* `@cmdutils.register`. This can, for example, be used to customize the flag an argument should get: [source,python]