diff --git a/.custom_wordlist.txt b/.custom_wordlist.txt index 4f3955a..0ee8b7f 100644 --- a/.custom_wordlist.txt +++ b/.custom_wordlist.txt @@ -1,5 +1,6 @@ adapter adapter's +AddingLaunchpadCelebrity analyze analyzer AppleApplications @@ -9,6 +10,7 @@ appservers artifact artifacts aspirational +AssertionsInLaunchpad attrgetter auditable auth @@ -16,8 +18,11 @@ authorization authorized authorizes autocert +autogenerated backend backends +backtrace +Backtraces Becca BEM Blazingly @@ -25,6 +30,7 @@ bool boolean breakpoint browserconfig +BrowserNotificationMessages bugtracker BugWatch BugWatches @@ -38,6 +44,7 @@ Centralized cgroup cgroups changeset +changesets charmcraft Cmd CMDLINE @@ -60,8 +67,13 @@ customize CVE Dalia Dalia's +DatabaseSchemaChangesProcess DatabaseSetup +DatetimeUsageGuide +DavidAllouche +dbschema ddl +DebuggingWithGdb defense defense deps @@ -72,6 +84,7 @@ distroseries DistroSeries distutils DNS +DocFileSuite docstring Docstring docstrings @@ -81,22 +94,29 @@ doctests docutils downstreams dtrt +EChangePolicy el else's emphasizes emphazising +EnumCol epydoc +Epytext +ExceptionGuidelines executables facetted fastnodowntime favicons +flavor formlib FreshLogs frontend frontends +gangotri globals gunicorn gzip +HackingLazrLibraries hostnames HSTS howto @@ -111,16 +131,22 @@ InformationInfrastructure infos initialized integrations +io ip IPv IPython javascript +Javadoc jenkaas jenkins jinja +kiko langpack +LaunchpadAuthentication +LaunchpadPpa lazr lifecycle +listdir logpoints logrotate lookup @@ -163,11 +189,16 @@ optstats organize organizing orm +os OSA OWASP OWASP's pagespeed PageSpeed +pagetest +pagetests +PageTests +pdb pentested performant pgsql @@ -175,10 +206,14 @@ pgSQL pipx plaintext po +PolicyandProcess +PolicyAndProcess +PolicyForDocumentingCustomDistributions pooler PostgreSQL PostGreSQL POSTs +ppa PPA PQM pre @@ -186,8 +221,10 @@ preprocessed prioritize prober prometheus +proxied py pydoctor +pypa PyPI qastaging queueddelivery @@ -198,6 +235,7 @@ quickstart rctp realfavicongenerator realizes +ReleaseCycles repo RESTful rocketfuel @@ -210,6 +248,7 @@ rsync runtime SafariWebContent sdist +segfaulted sendmail SendmailMailer setuptools @@ -219,6 +258,7 @@ smtp smtpMailer SMTPMailer snapshotting +SolutionsLog sourcecode sourceforge sourcepackage @@ -228,25 +268,32 @@ specialized specializes SRE SREs +srv +SshConnectionMultiplexing SSO +StagingServer standardized stdin steve stg +StormMigrationGuide stubmailer stubMailer +subclassing subdirectory subprocess sudo summarized svg symlinked +symlinks synchronize synchronizing syntax syntaxes systemd talisker +TeamEmail templating testability testbed @@ -254,8 +301,12 @@ testMailer TestMailer testrunner testrunner's +TestsFromChanges +TestsStyleGuide testtools +textarea TLS +traceback tradeoff tradeoffs Transactional @@ -267,6 +318,7 @@ UCT UltimateVimPythonSetup unauthorized Uncomment +unittest untriaged untrusted upstreams diff --git a/.sphinx/spellingcheck.yaml b/.sphinx/spellingcheck.yaml index 614db1b..46d7f43 100644 --- a/.sphinx/spellingcheck.yaml +++ b/.sphinx/spellingcheck.yaml @@ -9,7 +9,7 @@ matrix: - .custom_wordlist.txt output: .sphinx/.wordlist.dic sources: - - _build/**/*.html|!_build/explanation/hacking/index.html|!_build/help/index.html|!_build/contribute-to-our-docs/index.html|!_build/how-to/database-setup/index.html|!_build/how-to/submitting-a-patch/index.html|!_build/how-to/database-schema-changes-process/index.html|!_build/how-to/triage-bugs/index.html|!_build/explanation/registry/index.html|!_build/explanation/css-sprites/index.html|!_build/explanation/working-with-db-devel/index.html|!_build/explanation/pre-merge-reviews/index.html|!_build/explanation/live-patching/index.html|!_build/explanation/css/index.html|!_build/explanation/javascript-unittesting/index.html|!_build/explanation/engineering-overview-translations/index.html|!_build/explanation/testing/index.html|!_build/explanation/feature-flags/index.html|!_build/explanation/launchpad-ppa/index.html|!_build/explanation/branches/index.html|!_build/explanation/code/index.html|!_build/explanation/security-policy/index.html|!_build/explanation/database-performance/index.html|!_build/explanation/url-traversal/index.html|!_build/explanation/navigation-menus/index.html|!_build/explanation/storm-migration-guide/index.html|!_build/explanation/mail/index.html|!_build/explanation/javascript-buildsystem/index.html|!_build/explanation/javascript-integration-testing/index.html + - _build/**/*.html|!_build/help/index.html|!_build/contribute-to-our-docs/index.html|!_build/how-to/database-setup/index.html|!_build/how-to/submitting-a-patch/index.html|!_build/how-to/database-schema-changes-process/index.html|!_build/how-to/triage-bugs/index.html|!_build/explanation/registry/index.html|!_build/explanation/css-sprites/index.html|!_build/explanation/working-with-db-devel/index.html|!_build/explanation/pre-merge-reviews/index.html|!_build/explanation/live-patching/index.html|!_build/explanation/css/index.html|!_build/explanation/javascript-unittesting/index.html|!_build/explanation/engineering-overview-translations/index.html|!_build/explanation/testing/index.html|!_build/explanation/feature-flags/index.html|!_build/explanation/launchpad-ppa/index.html|!_build/explanation/branches/index.html|!_build/explanation/code/index.html|!_build/explanation/security-policy/index.html|!_build/explanation/database-performance/index.html|!_build/explanation/url-traversal/index.html|!_build/explanation/navigation-menus/index.html|!_build/explanation/storm-migration-guide/index.html|!_build/explanation/mail/index.html|!_build/explanation/javascript-buildsystem/index.html|!_build/explanation/javascript-integration-testing/index.html pipeline: - pyspelling.filters.html: comments: false diff --git a/explanation/hacking.rst b/explanation/hacking.rst index 1a4efb5..1bd5d47 100644 --- a/explanation/hacking.rst +++ b/explanation/hacking.rst @@ -309,7 +309,7 @@ seconds out of date, you should use the slave. If you don't need to update, but require up-to-date data, you should use -the default flavor. (eg. most views - the object you are viewing might just +the default flavor. (e.g. most views - the object you are viewing might just have been created). This will retrieve the master unless the load balancer is sure all changes made by the current client have propagated to the replica databases. @@ -350,7 +350,7 @@ But there is a common pattern you can use: call in that method another method on the object passed as parameter. That method can be appropriately protected using the current security infrastructure. -Since this auxillary method is part of an object-collaboration scenario, it's +Since this auxiliary method is part of an object-collaboration scenario, it's usually a good idea to start these methods with the **notify** verb. The method is notifying the other object that a collaboration is taking place. @@ -524,7 +524,7 @@ What kind of tests should we use? See the XXX TestsStyleGuide for the complete answer. -Short answer is that we favor the use of doctest in ``lib/lp/*/doc`` for API +Short answer is that we favour the use of doctest in ``lib/lp/*/doc`` for API documentation and XXX PageTests for use-cases documentation. We use doctests and regular python unittest to complete the coverage. How do I run just one doctest file, e.g. ``lib/lp/*/doc/mytest.txt``?