:smile:
', translate_emoticons: true, }, - // Test HTML Escape in Custom Zulip Rules + // Test HTML escaping in custom Zulip rules { input: "@**The Rogue One
**", expected: "@**<h1>The Rogue One</h1>**
", diff --git a/frontend_tests/node_tests/typeahead.js b/frontend_tests/node_tests/typeahead.js index 0220603b2e..d1f1100573 100644 --- a/frontend_tests/node_tests/typeahead.js +++ b/frontend_tests/node_tests/typeahead.js @@ -48,33 +48,33 @@ run_test("get_emoji_matcher", () => { run_test("triage", () => { const alice = {name: "alice"}; - const Alicia = {name: "Alicia"}; + const alicia = {name: "Alicia"}; const steve = {name: "steve"}; - const Stephanie = {name: "Stephanie"}; + const stephanie = {name: "Stephanie"}; - const names = [alice, Alicia, steve, Stephanie]; + const names = [alice, alicia, steve, stephanie]; assert.deepEqual( typeahead.triage("a", names, (r) => r.name), { - matches: [alice, Alicia], - rest: [steve, Stephanie], + matches: [alice, alicia], + rest: [steve, stephanie], }, ); assert.deepEqual( typeahead.triage("A", names, (r) => r.name), { - matches: [Alicia, alice], - rest: [steve, Stephanie], + matches: [alicia, alice], + rest: [steve, stephanie], }, ); assert.deepEqual( typeahead.triage("S", names, (r) => r.name), { - matches: [Stephanie, steve], - rest: [alice, Alicia], + matches: [stephanie, steve], + rest: [alice, alicia], }, ); @@ -82,7 +82,7 @@ run_test("triage", () => { typeahead.triage("fred", names, (r) => r.name), { matches: [], - rest: [alice, Alicia, steve, Stephanie], + rest: [alice, alicia, steve, stephanie], }, ); }); diff --git a/frontend_tests/node_tests/typeahead_helper.js b/frontend_tests/node_tests/typeahead_helper.js index 1a8a5148dc..43b0dbf7cb 100644 --- a/frontend_tests/node_tests/typeahead_helper.js +++ b/frontend_tests/node_tests/typeahead_helper.js @@ -143,7 +143,7 @@ run_test("sort_languages", () => { const a_bot = { email: "a_bot@zulip.com", - full_name: "A zulip test bot", + full_name: "A Zulip test bot", is_admin: false, is_bot: true, user_id: 1, @@ -151,7 +151,7 @@ const a_bot = { const a_user = { email: "a_user@zulip.org", - full_name: "A zulip user", + full_name: "A Zulip user", is_admin: false, is_bot: false, user_id: 2, diff --git a/frontend_tests/puppeteer_tests/04-subscriptions.js b/frontend_tests/puppeteer_tests/04-subscriptions.js index bdf4ff27dd..ade26b39a9 100644 --- a/frontend_tests/puppeteer_tests/04-subscriptions.js +++ b/frontend_tests/puppeteer_tests/04-subscriptions.js @@ -123,7 +123,7 @@ async function create_stream(page) { await page.waitForXPath('//*[text()="Create stream"]', {visible: true}); await common.fill_form(page, "form#stream_creation_form", { stream_name: "Puppeteer", - stream_description: "Everything puppeteer", + stream_description: "Everything Puppeteer", }); await page.click(await stream_span(page, "Scotland")); // Subscribes all users from Scotland await page.click(await user_span(page, "cordelia")); // Add cordelia. @@ -142,7 +142,7 @@ async function create_stream(page) { ); const subscriber_count_selector = "[data-stream-name='Puppeteer'] .subscriber-count"; assert.strictEqual(stream_name, "Puppeteer"); - assert.strictEqual(stream_description, "Everything puppeteer"); + assert.strictEqual(stream_description, "Everything Puppeteer"); // Assert subscriber count becomes 5(scotland(+4), cordelia(+1), othello(-1), Desdemona(+1)). await page.waitForFunction( diff --git a/frontend_tests/puppeteer_tests/07-navigation.js b/frontend_tests/puppeteer_tests/07-navigation.js index 934ad22edb..339af97146 100644 --- a/frontend_tests/puppeteer_tests/07-navigation.js +++ b/frontend_tests/puppeteer_tests/07-navigation.js @@ -78,7 +78,7 @@ async function navigation_tests(page) { await navigate_to(page, verona_narrow, "message_feed_container"); // Hardcoded this instead of using `navigate_to` - // as puppeteer cannot click hidden elements. + // as Puppeteer cannot click hidden elements. await page.evaluate(() => $("a[href='#message_feed_container]'").click()); await wait_for_tab(page, "message_feed_container"); diff --git a/frontend_tests/zjsunit/mdiff.js b/frontend_tests/zjsunit/mdiff.js index 70fcfd34ec..464fe0ee6b 100644 --- a/frontend_tests/zjsunit/mdiff.js +++ b/frontend_tests/zjsunit/mdiff.js @@ -10,7 +10,7 @@ * Based on diffing library difflib, a js port of the python library. * * The sole exported function diff_strings(string_0, string_1) returns a pretty-printed - * unicode string containing their diff. + * Unicode string containing their diff. */ const difflib = require("difflib"); diff --git a/puppet/zulip/files/nagios_plugins/zulip_app_frontend/check_rabbitmq_consumers b/puppet/zulip/files/nagios_plugins/zulip_app_frontend/check_rabbitmq_consumers index b961b3cc3d..f6fb8ffee7 100755 --- a/puppet/zulip/files/nagios_plugins/zulip_app_frontend/check_rabbitmq_consumers +++ b/puppet/zulip/files/nagios_plugins/zulip_app_frontend/check_rabbitmq_consumers @@ -1,7 +1,7 @@ #!/usr/bin/env python3 """ -Nagios plugin to check that the rabbitmq has the correct number of consumers. +Nagios plugin to check that the RabbitMQ has the correct number of consumers. This script just checks the contents of /var/lib/nagios_state/check-rabbitmq-consumers, which is generated by scripts/nagios/check-rabbitmq-consumers. diff --git a/puppet/zulip/files/nagios_plugins/zulip_app_frontend/check_rabbitmq_queues b/puppet/zulip/files/nagios_plugins/zulip_app_frontend/check_rabbitmq_queues index 587ad906f1..bb77cb29a7 100755 --- a/puppet/zulip/files/nagios_plugins/zulip_app_frontend/check_rabbitmq_queues +++ b/puppet/zulip/files/nagios_plugins/zulip_app_frontend/check_rabbitmq_queues @@ -1,7 +1,7 @@ #!/usr/bin/env python3 """ -Nagios plugin to check that the rabbitmq queues are not overflowing as a result +Nagios plugin to check that the RabbitMQ queues are not overflowing as a result of a stuck consumer. This script just checks the contents of /var/lib/nagios_state/check-rabbitmq-results, diff --git a/puppet/zulip/files/nagios_plugins/zulip_postgres_appdb/check_postgres_replication_lag b/puppet/zulip/files/nagios_plugins/zulip_postgres_appdb/check_postgres_replication_lag index 41ebdcaf2a..6669a96e39 100755 --- a/puppet/zulip/files/nagios_plugins/zulip_postgres_appdb/check_postgres_replication_lag +++ b/puppet/zulip/files/nagios_plugins/zulip_postgres_appdb/check_postgres_replication_lag @@ -2,7 +2,7 @@ """Nagios plugin to check the difference between the primary and replica Postgres servers' xlog location. Requires that the user this -connects to postgres as has been granted the `pg_monitor` role. +connects to Postgres as has been granted the `pg_monitor` role. """ import re diff --git a/puppet/zulip/files/postgresql/process_fts_updates b/puppet/zulip/files/postgresql/process_fts_updates index 3ede1606d3..dac753506c 100755 --- a/puppet/zulip/files/postgresql/process_fts_updates +++ b/puppet/zulip/files/postgresql/process_fts_updates @@ -1,10 +1,10 @@ #!/usr/bin/env python3 -# Processes updates to postgres Full Text Search for new/edited messages. +# Processes updates to Postgres full-text search for new/edited messages. # -# Zulip manages its postgres full-text search as follows. When the -# content of a message is modified, a postgres trigger logs the +# Zulip manages its Postgres full-text search as follows. When the +# content of a message is modified, a Postgres trigger logs the # message ID to the `fts_update_log` table. In the background, this -# program processes `fts_update_log`, updating the postgres full-text +# program processes `fts_update_log`, updating the Postgres full-text # search column search_tsvector in the main zerver_message. import sys @@ -88,12 +88,12 @@ try: USING_PGROONGA = settings.USING_PGROONGA except ImportError: # process_fts_updates also supports running locally on a remote - # postgres server; in that case, one can just connect to localhost + # Postgres server; in that case, one can just connect to localhost USING_PGROONGA = False # Since we don't want a hard dependency on being able to access the # Zulip settings (as we may not be running on a server that has that -# data), we determine whether we're using pgroonga using +# data), we determine whether we're using PGroonga using # /etc/zulip/zulip.conf. # # However, we still also check the `USING_PGROONGA` variable, since diff --git a/puppet/zulip/manifests/app_frontend_base.pp b/puppet/zulip/manifests/app_frontend_base.pp index cbe7f10679..5d75d2f306 100644 --- a/puppet/zulip/manifests/app_frontend_base.pp +++ b/puppet/zulip/manifests/app_frontend_base.pp @@ -9,7 +9,7 @@ class zulip::app_frontend_base { if $::osfamily == 'debian' { # Upgrade and other tooling wants to be able to get a database - # shell. This is not necessary on CentOS because the postgresql + # shell. This is not necessary on CentOS because the PostgreSQL # package already includes the client. This may get us a more # recent client than the database server is configured to be, # ($zulip::postgres_common::version), but they're compatible. diff --git a/puppet/zulip/manifests/base.pp b/puppet/zulip/manifests/base.pp index 5a78f93bf5..25a51891ca 100644 --- a/puppet/zulip/manifests/base.pp +++ b/puppet/zulip/manifests/base.pp @@ -34,7 +34,7 @@ class zulip::base { # Used in scripts including install-yarn.sh 'curl', 'wget', - # Used to read /etc/zulip/zulip.conf for `zulipconf` puppet function + # Used to read /etc/zulip/zulip.conf for `zulipconf` Puppet function 'crudini', # Used for tools like sponge 'moreutils', @@ -42,7 +42,7 @@ class zulip::base { $zulip::common::nagios_plugins, # Required for using HTTPS in apt repositories. 'apt-transport-https', - # Needed for the cron jobs installed by puppet + # Needed for the cron jobs installed by Puppet 'cron', ] } diff --git a/puppet/zulip/manifests/dockervoyager.pp b/puppet/zulip/manifests/dockervoyager.pp index 2511276a94..43f6c2afb0 100644 --- a/puppet/zulip/manifests/dockervoyager.pp +++ b/puppet/zulip/manifests/dockervoyager.pp @@ -1,6 +1,6 @@ # This class includes all the modules you need to install/run a Zulip installation -# in a single container (without the database, memcached, redis services). -# The database, memcached, redis services need to be run in separate containers. +# in a single container (without the database, memcached, Redis services). +# The database, memcached, Redis services need to be run in separate containers. # Through this split of services, it is easier to scale the services to the needs. class zulip::dockervoyager { include zulip::base diff --git a/puppet/zulip/manifests/postgres_appdb_base.pp b/puppet/zulip/manifests/postgres_appdb_base.pp index 3fdc85abbb..fd6d4e904f 100644 --- a/puppet/zulip/manifests/postgres_appdb_base.pp +++ b/puppet/zulip/manifests/postgres_appdb_base.pp @@ -1,4 +1,4 @@ -# Minimal shared configuration needed to run a Zulip postgres database. +# Minimal shared configuration needed to run a Zulip Postgres database. class zulip::postgres_appdb_base { include zulip::postgres_common include zulip::process_fts_updates @@ -33,7 +33,7 @@ class zulip::postgres_appdb_base { $pgroonga_setup_sql_path = "${postgres_sharedir}/pgroonga_setup.sql" $setup_system_deps = 'setup_yum_repo' $postgres_restart = "systemctl restart postgresql-${zulip::postgres_common::version}" - # TODO Since we can't find the postgres dicts directory on CentOS yet, we + # TODO Since we can't find the Postgres dicts directory on CentOS yet, we # link directly to the hunspell directory. $postgres_dict_dict = '/usr/share/myspell/en_US.dic' $postgres_dict_affix = '/usr/share/myspell/en_US.aff' diff --git a/puppet/zulip/manifests/rabbit.pp b/puppet/zulip/manifests/rabbit.pp index 8c4c6fe62a..46523e6fa5 100644 --- a/puppet/zulip/manifests/rabbit.pp +++ b/puppet/zulip/manifests/rabbit.pp @@ -3,7 +3,7 @@ class zulip::rabbit { 'debian' => 'erlang-base', 'redhat' => 'erlang', } - $rabbit_packages = [# Needed to run rabbitmq + $rabbit_packages = [# Needed to run RabbitMQ $erlang, 'rabbitmq-server', ] diff --git a/puppet/zulip/manifests/tornado_sharding.pp b/puppet/zulip/manifests/tornado_sharding.pp index ab390687f0..231a97a445 100644 --- a/puppet/zulip/manifests/tornado_sharding.pp +++ b/puppet/zulip/manifests/tornado_sharding.pp @@ -6,7 +6,7 @@ class zulip::tornado_sharding { # The file entries below serve only to initialize the sharding config files # with the correct default content for the "only one shard" setup. For this # reason they use "replace => false", because the files are managed by - # the sharding script afterwards and puppet shouldn't overwrite them. + # the sharding script afterwards and Puppet shouldn't overwrite them. file { '/etc/zulip/nginx_sharding.conf': ensure => file, owner => 'root', diff --git a/puppet/zulip/templates/postfix/main.cf.erb b/puppet/zulip/templates/postfix/main.cf.erb index d3ed869570..fed7e94b51 100644 --- a/puppet/zulip/templates/postfix/main.cf.erb +++ b/puppet/zulip/templates/postfix/main.cf.erb @@ -1,4 +1,4 @@ -# This file is managed by puppet; local changes will be overridden. +# This file is managed by Puppet; local changes will be overridden. smtpd_banner = $myhostname ESMTP $mail_name (Zulip) biff = no diff --git a/puppet/zulip_ops/files/munin-plugins/tornado_event_queues b/puppet/zulip_ops/files/munin-plugins/tornado_event_queues index 9e45b91b8e..f59be5a688 100755 --- a/puppet/zulip_ops/files/munin-plugins/tornado_event_queues +++ b/puppet/zulip_ops/files/munin-plugins/tornado_event_queues @@ -4,7 +4,7 @@ # # Usage: Link or copy into /etc/munin/node.d/ # -# No Parameters +# No parameters # # Magic markers (optional - only used by munin-config and some # installation scripts): diff --git a/puppet/zulip_ops/files/nagios3/conf.d/hostgroups.cfg b/puppet/zulip_ops/files/nagios3/conf.d/hostgroups.cfg index 00a846a2ad..881f2b101a 100644 --- a/puppet/zulip_ops/files/nagios3/conf.d/hostgroups.cfg +++ b/puppet/zulip_ops/files/nagios3/conf.d/hostgroups.cfg @@ -1,7 +1,7 @@ # A simple wildcard hostgroup define hostgroup { hostgroup_name all - alias All Servers + alias All servers members * } @@ -17,70 +17,70 @@ define hostgroup { define hostgroup { hostgroup_name web - alias Web Servers + alias Web servers } define hostgroup { hostgroup_name frontends - alias Frontend Web Servers + alias Frontend web servers } define hostgroup { hostgroup_name staging_frontends - alias Staging Frontend Web Servers + alias Staging frontend web servers } define hostgroup { hostgroup_name prod_frontends - alias Production Frontend Web Servers + alias Production frontend web servers } define hostgroup { hostgroup_name multitornado_frontends - alias Frontend Web Servers with multiple Tornado processes + alias Frontend web servers with multiple Tornado processes } define hostgroup { hostgroup_name singletornado_frontends - alias Frontend Web Servers with a single Tornado process + alias Frontend web servers with a single Tornado process } define hostgroup { hostgroup_name redis - alias Redis Servers + alias Redis servers hostgroup_members frontends } define hostgroup { hostgroup_name zmirror - alias Zephyr Mirror Servers + alias Zephyr mirror servers } define hostgroup { hostgroup_name zmirrorp - alias Zephyr Mirror Personals Servers + alias Zephyr mirror personals servers } define hostgroup { hostgroup_name zmirror_main - alias Zephyr Mirror Main Servers + alias Zephyr mirror main servers } define hostgroup { hostgroup_name postgres - alias PostgreSQL Servers + alias PostgreSQL servers hostgroup_members postgres_appdb } define hostgroup { hostgroup_name postgres_appdb - alias PostgreSQL App Servers + alias PostgreSQL app servers hostgroup_members postgres_appdb_primary } define hostgroup { hostgroup_name postgres_appdb_primary - alias Primary PostgreSQL App Servers + alias Primary PostgreSQL app servers } define hostgroup { diff --git a/puppet/zulip_ops/files/nagios3/conf.d/services.cfg b/puppet/zulip_ops/files/nagios3/conf.d/services.cfg index 744282a305..59ef289490 100644 --- a/puppet/zulip_ops/files/nagios3/conf.d/services.cfg +++ b/puppet/zulip_ops/files/nagios3/conf.d/services.cfg @@ -156,7 +156,7 @@ define service { define service { use generic-service - service_description Check postgres autovac_freeze + service_description Check Postgres autovac_freeze check_command check_postgres!zulip!nagios!autovac_freeze hostgroup postgres_appdb_primary contact_groups admins @@ -164,7 +164,7 @@ define service { define service { use generic-service - service_description Check postgres backends + service_description Check Postgres backends check_command check_postgres!zulip!nagios!backends hostgroup postgres_appdb contact_groups admins @@ -172,7 +172,7 @@ define service { define service { use generic-service - service_description Check postgres connection + service_description Check Postgres connection check_command check_postgres!zulip!nagios!connection hostgroup postgres_appdb contact_groups page_admins @@ -180,7 +180,7 @@ define service { define service { use generic-service - service_description Check postgres disabled triggers + service_description Check Postgres disabled triggers check_command check_postgres!zulip!nagios!disabled_triggers hostgroup postgres_appdb contact_groups admins @@ -188,7 +188,7 @@ define service { define service { use generic-service - service_description Check postgres hitratio + service_description Check Postgres hitratio check_command check_postgres!zulip!nagios!hitratio hostgroup postgres_appdb contact_groups admins @@ -196,7 +196,7 @@ define service { define service { use generic-service - service_description Check postgres locks + service_description Check Postgres locks check_command check_postgres_alert_args!zulip!nagios!locks!400!600 hostgroup postgres_appdb contact_groups admins @@ -204,7 +204,7 @@ define service { define service { use generic-service - service_description Check postgres query_time + service_description Check Postgres query_time check_command check_postgres_alert_args!zulip!nagios!query_time!20 seconds!40 seconds hostgroup postgres_appdb contact_groups admins @@ -212,7 +212,7 @@ define service { define service { use generic-service - service_description Check postgres sequence + service_description Check Postgres sequence check_command check_postgres!zulip!nagios!sequence hostgroup postgres_appdb contact_groups admins @@ -220,7 +220,7 @@ define service { define service { use generic-service - service_description Check postgres timesync + service_description Check Postgres timesync check_command check_postgres!zulip!nagios!timesync hostgroup postgres_appdb contact_groups admins @@ -228,7 +228,7 @@ define service { # define service { # use generic-service -# service_description Check postgres txn_idle +# service_description Check Postgres txn_idle # check_command check_postgres_alert_args!zulip!nagios!txn_idle!20 seconds!40 seconds # hostgroup postgres_appdb # contact_groups admins @@ -236,7 +236,7 @@ define service { define service { use generic-service - service_description Check postgres txn_time + service_description Check Postgres txn_time check_command check_postgres_alert_args!zulip!nagios!txn_time!20 seconds!40 seconds hostgroup postgres_appdb contact_groups admins @@ -252,7 +252,7 @@ define service { define service{ use generic-service - service_description Check postgres replication lag + service_description Check Postgres replication lag check_command check_postgres_replication_lag hostgroup postgres_appdb contact_groups admins @@ -288,7 +288,7 @@ define service { define service { use generic-service - service_description Check rabbitmq queue sizes + service_description Check RabbitMQ queue sizes check_command check_rabbitmq_queues!22 # Workaround weird checks 40s after first error causing alerts # from a single failure because cron hasn't run again yet @@ -307,7 +307,7 @@ define service { define service { use generic-service - service_description Check rabbitmq notify_tornado consumers + service_description Check RabbitMQ notify_tornado consumers check_command check_rabbitmq_consumers!notify_tornado # Workaround weird checks 40s after first error causing alerts # from a single failure because cron hasn't run again yet @@ -318,7 +318,7 @@ define service { define service { use generic-service - service_description Check rabbitmq user_activity_interval consumers + service_description Check RabbitMQ user_activity_interval consumers check_command check_rabbitmq_consumers!user_activity_interval # Workaround weird checks 40s after first error causing alerts # from a single failure because cron hasn't run again yet @@ -329,7 +329,7 @@ define service { define service { use generic-service - service_description Check rabbitmq user_presence consumers + service_description Check RabbitMQ user_presence consumers check_command check_rabbitmq_consumers!user_presence # Workaround weird checks 40s after first error causing alerts # from a single failure because cron hasn't run again yet @@ -340,7 +340,7 @@ define service { define service { use generic-service - service_description Check rabbitmq invites consumers + service_description Check RabbitMQ invites consumers check_command check_rabbitmq_consumers!invites # Workaround weird checks 40s after first error causing alerts # from a single failure because cron hasn't run again yet @@ -351,7 +351,7 @@ define service { define service { use generic-service - service_description Check rabbitmq signups consumers + service_description Check RabbitMQ signups consumers check_command check_rabbitmq_consumers!signups # Workaround weird checks 40s after first error causing alerts # from a single failure because cron hasn't run again yet @@ -362,7 +362,7 @@ define service { define service { use generic-service - service_description Check rabbitmq digest email consumers + service_description Check RabbitMQ digest email consumers check_command check_rabbitmq_consumers!digest_emails # Workaround weird checks 40s after first error causing alerts # from a single failure because cron hasn't run again yet @@ -373,7 +373,7 @@ define service { define service { use generic-service - service_description Check rabbitmq email mirror consumers + service_description Check RabbitMQ email mirror consumers check_command check_rabbitmq_consumers!email_mirror # Workaround weird checks 40s after first error causing alerts # from a single failure because cron hasn't run again yet @@ -384,7 +384,7 @@ define service { define service { use generic-service - service_description Check rabbitmq missedmessage mobile notifications consumers + service_description Check RabbitMQ missedmessage mobile notifications consumers check_command check_rabbitmq_consumers!missedmessage_mobile_notifications # Workaround weird checks 40s after first error causing alerts # from a single failure because cron hasn't run again yet @@ -395,7 +395,7 @@ define service { define service { use generic-service - service_description Check rabbitmq missedmessage email consumers + service_description Check RabbitMQ missedmessage email consumers check_command check_rabbitmq_consumers!missedmessage_email # Workaround weird checks 40s after first error causing alerts # from a single failure because cron hasn't run again yet @@ -406,7 +406,7 @@ define service { define service { use generic-service - service_description Check rabbitmq user activity consumers + service_description Check RabbitMQ user activity consumers check_command check_rabbitmq_consumers!user_activity # Workaround weird checks 40s after first error causing alerts # from a single failure because cron hasn't run again yet diff --git a/puppet/zulip_ops/manifests/base.pp b/puppet/zulip_ops/manifests/base.pp index f2e1a2c000..e5d523d9b1 100644 --- a/puppet/zulip_ops/manifests/base.pp +++ b/puppet/zulip_ops/manifests/base.pp @@ -190,8 +190,8 @@ class zulip_ops::base { ensure => running, # Because there is no running process for this service, the normal status - # checks fail. Because puppet then thinks the service has been manually - # stopped, it won't restart it. This fake status command will trick puppet + # checks fail. Because Puppet then thinks the service has been manually + # stopped, it won't restart it. This fake status command will trick Puppet # into thinking the service is *always* running (which in a way it is, as # iptables is part of the kernel.) hasstatus => true, diff --git a/requirements/common.in b/requirements/common.in index b845bdc585..5357da329a 100644 --- a/requirements/common.in +++ b/requirements/common.in @@ -23,7 +23,7 @@ jsx-lexer # Needed for manage.py ipython -# Needed for Image Processing +# Needed for image processing Pillow # Needed for building complex DB queries @@ -59,7 +59,7 @@ httplib2 # Forked to avoid pulling in scipy: https://github.com/mailgun/talon/issues/130 https://github.com/zulip/talon/archive/7d8bdc4dbcfcc5a73298747293b99fe53da55315.zip#egg=talon==1.2.10.zulip1 -# Needed for hipchat import +# Needed for HipChat import hypchat # Needed for inlining the CSS in emails @@ -71,7 +71,7 @@ PyJWT # Needed for including other Markdown files for user docs markdown-include -# Needed to access rabbitmq +# Needed to access RabbitMQ pika # Needed to access our database @@ -89,7 +89,7 @@ python-dateutil # Needed for timezone work pytz -# Needed for redis +# Needed for Redis redis # Needed to parse source maps for error reporting diff --git a/scripts/lib/clean-unused-caches b/scripts/lib/clean-unused-caches index 5c548918bc..3d3f4d0202 100755 --- a/scripts/lib/clean-unused-caches +++ b/scripts/lib/clean-unused-caches @@ -9,7 +9,7 @@ from scripts.lib.zulip_tools import parse_cache_script_args def main() -> None: - args = parse_cache_script_args("This script cleans unused zulip caches.") + args = parse_cache_script_args("This script cleans unused Zulip caches.") os.chdir(ZULIP_PATH) clean_venv_cache.main(args) clean_node_cache.main(args) diff --git a/scripts/lib/clean_emoji_cache.py b/scripts/lib/clean_emoji_cache.py index 6457949c54..ded3759667 100755 --- a/scripts/lib/clean_emoji_cache.py +++ b/scripts/lib/clean_emoji_cache.py @@ -43,5 +43,5 @@ def main(args: argparse.Namespace) -> None: EMOJI_CACHE_PATH, caches_in_use, "emoji cache", args) if __name__ == "__main__": - args = parse_cache_script_args("This script cleans unused zulip emoji caches.") + args = parse_cache_script_args("This script cleans unused Zulip emoji caches.") main(args) diff --git a/scripts/lib/clean_node_cache.py b/scripts/lib/clean_node_cache.py index b1fd1db0c3..c3a36c2ea5 100755 --- a/scripts/lib/clean_node_cache.py +++ b/scripts/lib/clean_node_cache.py @@ -46,5 +46,5 @@ def main(args: argparse.Namespace) -> None: NODE_MODULES_CACHE_PATH, caches_in_use, "node modules cache", args) if __name__ == "__main__": - args = parse_cache_script_args("This script cleans unused zulip npm caches.") + args = parse_cache_script_args("This script cleans unused Zulip npm caches.") main(args) diff --git a/scripts/lib/clean_venv_cache.py b/scripts/lib/clean_venv_cache.py index 513b4d532f..e8090cf10f 100755 --- a/scripts/lib/clean_venv_cache.py +++ b/scripts/lib/clean_venv_cache.py @@ -54,5 +54,5 @@ def main(args: argparse.Namespace) -> None: VENV_CACHE_DIR, caches_in_use, "venv cache", args) if __name__ == "__main__": - args = parse_cache_script_args("This script cleans unused zulip venv caches.") + args = parse_cache_script_args("This script cleans unused Zulip venv caches.") main(args) diff --git a/scripts/lib/email-mirror-postfix b/scripts/lib/email-mirror-postfix index 3eafc7d9a9..1709ff3164 100755 --- a/scripts/lib/email-mirror-postfix +++ b/scripts/lib/email-mirror-postfix @@ -6,13 +6,13 @@ forwarding emails into Zulip. https://zulip.readthedocs.io/en/latest/production/settings.html#email-gateway The email gateway supports two major modes of operation: An email -server (using postfix) where the email address configured in +server (using Postfix) where the email address configured in EMAIL_GATEWAY_PATTERN delivers emails directly to Zulip (this) or a cron job that connects to an IMAP inbox (which receives the emails) periodically. -Zulip's puppet configuration takes care of configuring postfix to -execute this script when emails are received by postfix, piping the +Zulip's Puppet configuration takes care of configuring Postfix to +execute this script when emails are received by Postfix, piping the email content via standard input (and the destination email address in the ORIGINAL_RECIPIENT environment variable). @@ -65,7 +65,7 @@ parser.add_argument('-d', '--dst-host', dest="host", default='https://127.0.0.1' "Address must contain a HTTP protocol.") parser.add_argument('-u', '--dst-url', dest="url", default='/email_mirror_message', - help="Destination relative url for uploading email from email mirror.") + help="Destination relative URL for uploading email from email mirror.") parser.add_argument('-n', '--not-verify-ssl', dest="verify_ssl", action='store_false', help="Disable ssl certificate verifying for self-signed certificates") diff --git a/scripts/lib/install b/scripts/lib/install index 4200efa814..5af3c5b2b8 100755 --- a/scripts/lib/install +++ b/scripts/lib/install @@ -121,7 +121,7 @@ fi read -r -a APT_OPTIONS <<<"${APT_OPTIONS:-}" # Install additional packages. read -r -a ADDITIONAL_PACKAGES <<<"${ADDITIONAL_PACKAGES:-}" -# Comma-separated list of puppet manifests to install. default is +# Comma-separated list of Puppet manifests to install. default is # zulip::voyager for an all-in-one system or zulip::dockervoyager for # Docker. Use e.g. zulip::app_frontend for a Zulip frontend server. PUPPET_CLASSES="${PUPPET_CLASSES:-zulip::voyager}" @@ -234,8 +234,8 @@ fi case ",$PUPPET_CLASSES," in *,zulip::voyager,* | *,zulip::postgres_appdb_tuned,*) if [ "$package_system" = apt ]; then - # We're going to install Postgres from the postgres apt - # repository; this may conflict with the existing postgres. + # We're going to install Postgres from the Postgres apt + # repository; this may conflict with the existing Postgres. OTHER_PG="$(dpkg --get-selections \ | grep -E '^postgresql-[0-9]+\s+install$' \ | grep -v "^postgresql-$POSTGRES_VERSION\b" \ @@ -405,7 +405,7 @@ EOF --classfile=/var/lib/puppet/classes.txt \ >/dev/null - # We only need the postgres version setting on database hosts; but + # We only need the Postgres version setting on database hosts; but # we don't know if this is a database host until we have the catalog summary. if ! has_class "zulip::postgres_common" || [ "$package_system" != apt ]; then crudini --del /etc/zulip/zulip.conf postgresql @@ -511,7 +511,7 @@ if has_class "zulip::app_frontend_base"; then chown -R zulip:zulip /home/zulip /var/log/zulip /etc/zulip/settings.py if ! [ -e "/home/zulip/prod-static/generated" ]; then - # If we're installing from a git checkout, we need to run + # If we're installing from a Git checkout, we need to run # `tools/update-prod-static` in order to build the static # assets. su zulip -c '/home/zulip/deployments/current/tools/update-prod-static' @@ -525,7 +525,7 @@ if [ -n "$NO_INIT_DB" ]; then Success! Stopping because --no-init-db was passed. - To complete the installation, configure postgres and then run: + To complete the installation, configure Postgres and then run: su zulip -c '/home/zulip/deployments/current/scripts/setup/initialize-database' su zulip -c '/home/zulip/deployments/current/manage.py generate_realm_creation_link' diff --git a/scripts/lib/upgrade-zulip-stage-2 b/scripts/lib/upgrade-zulip-stage-2 index 69bc998f18..e0afd57a47 100755 --- a/scripts/lib/upgrade-zulip-stage-2 +++ b/scripts/lib/upgrade-zulip-stage-2 @@ -199,19 +199,19 @@ elif args.from_git: logging.info("Shutting down server to build static assets on a low-RAM system.") shutdown_server() - # Note: The fact that this is before we apply puppet changes means - # that we don't support adding new puppet dependencies of - # update-prod-static with the git upgrade process. But it'll fail + # Note: The fact that this is before we apply Puppet changes means + # that we don't support adding new Puppet dependencies of + # update-prod-static with the Git upgrade process. But it'll fail # safely; this seems like a worthwhile tradeoff to minimize downtime. logging.info("Building static assets...") subprocess.check_call(["./tools/update-prod-static", "--prev-deploy=" + os.path.join(DEPLOYMENTS_DIR, 'current')], preexec_fn=su_to_zulip) - logging.info("Caching zulip git version...") + logging.info("Caching Zulip Git version...") subprocess.check_call(["./tools/cache-zulip-git-version"], preexec_fn=su_to_zulip) else: # Since this doesn't do any actual work, it's likely safe to have - # this run before we apply puppet changes (saving a bit of downtime). + # this run before we apply Puppet changes (saving a bit of downtime). logging.info("Installing static assets...") subprocess.check_call(["cp", "-rT", os.path.join(deploy_path, 'prod-static/serve'), '/home/zulip/prod-static'], preexec_fn=su_to_zulip) @@ -252,12 +252,12 @@ if os.path.exists("/etc/supervisor/conf.d/zulip_db.conf"): if (not args.skip_puppet or migrations_needed) and IS_SERVER_UP: # By default, we shut down the service to apply migrations and - # puppet changes, to minimize risk of issues due to inconsistent + # Puppet changes, to minimize risk of issues due to inconsistent # state. shutdown_server() if not args.skip_puppet: - logging.info("Applying puppet changes...") + logging.info("Applying Puppet changes...") subprocess.check_call(["./scripts/zulip-puppet-apply", "--force"]) subprocess.check_call(["apt-get", "-y", "upgrade"]) @@ -283,5 +283,5 @@ else: logging.info("Skipping purging old deployments.") if args.skip_puppet: - logging.info("Showing un-applied puppet changes:") + logging.info("Showing un-applied Puppet changes:") subprocess.check_call(["./scripts/zulip-puppet-apply", "--noop", "--show_diff"]) diff --git a/scripts/setup/generate_secrets.py b/scripts/setup/generate_secrets.py index bd6a4179c1..6e1e757269 100755 --- a/scripts/setup/generate_secrets.py +++ b/scripts/setup/generate_secrets.py @@ -124,7 +124,7 @@ def generate_secrets(development: bool = False) -> None: if settings.MEMCACHED_LOCATION == "127.0.0.1:11211": add_secret("memcached_password", random_token()) - # Password for authentication to redis. + # Password for authentication to Redis. if need_secret("redis_password"): # We defer importing settings unless we need it, because # importing settings is expensive (mostly because of diff --git a/scripts/setup/postgres-init-db b/scripts/setup/postgres-init-db index 71a1303d34..5a06229c1a 100755 --- a/scripts/setup/postgres-init-db +++ b/scripts/setup/postgres-init-db @@ -10,7 +10,7 @@ set -x # What user should we use for connecting to the database POSTGRES_USER="${POSTGRES_USER:-postgres}" -# This psql command may fail because the zulip database doesn’t exist, +# This psql command may fail because the Zulip database doesn’t exist, # hence the &&. if records="$( cd / # Make sure the current working directory is readable by postgres diff --git a/scripts/setup/restore-backup b/scripts/setup/restore-backup index 10a076f573..11bf1bfad3 100755 --- a/scripts/setup/restore-backup +++ b/scripts/setup/restore-backup @@ -115,10 +115,10 @@ def restore_backup(tarball_file: IO[bytes]) -> None: "--production", ]) - # If there is a local rabbitmq, we need to reconfigure it - # to ensure the rabbitmq password matches the value in the + # If there is a local RabbitMQ, we need to reconfigure it + # to ensure the RabbitMQ password matches the value in the # restored zulip-secrets.conf. We need to be careful to - # only do this if rabbitmq is configured to run locally on + # only do this if RabbitMQ is configured to run locally on # the system. rabbitmq_host = subprocess.check_output( [os.path.join(settings.DEPLOY_ROOT, diff --git a/scripts/setup/upgrade-postgres b/scripts/setup/upgrade-postgres index c1925895ce..34a2e0dd29 100755 --- a/scripts/setup/upgrade-postgres +++ b/scripts/setup/upgrade-postgres @@ -24,8 +24,8 @@ if pg_lsclusters -h | grep -qE "^$UPGRADE_TO\s+main\b"; then fi ( - # Two-stage application of puppet; we apply the bare-bones - # postgresql configuration first, so that FTS will be configured + # Two-stage application of Puppet; we apply the bare-bones + # PostgreSQL configuration first, so that FTS will be configured # prior to the pg_upgradecluster. TEMP_CONF_DIR=$(mktemp -d) cp /etc/zulip/zulip.conf "$TEMP_CONF_DIR" diff --git a/scripts/zulip-puppet-apply b/scripts/zulip-puppet-apply index 2d6ce2c659..42bebb38fb 100755 --- a/scripts/zulip-puppet-apply +++ b/scripts/zulip-puppet-apply @@ -11,7 +11,7 @@ from lib.zulip_tools import assert_running_as_root, parse_os_release assert_running_as_root() BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) -parser = argparse.ArgumentParser(description="Run puppet") +parser = argparse.ArgumentParser(description="Run Puppet") parser.add_argument('--force', '-f', action="store_true", help="Do not prompt with proposed changes") parser.add_argument('--noop', action="store_true", @@ -32,7 +32,7 @@ Exec { path => "/usr/sbin:/usr/bin:/sbin:/bin" } for pclass in re.split(r'\s*,\s*', config.get('machine', 'puppet_classes')): puppet_config += f"include {pclass}\n" -# We use the puppet configuration from the same Zulip checkout as this script +# We use the Puppet configuration from the same Zulip checkout as this script scripts_path = os.path.join(BASE_DIR, "scripts") puppet_module_path = os.path.join(BASE_DIR, "puppet") puppet_cmd = ["puppet", "apply", f"--modulepath={puppet_module_path}", "-e", puppet_config] @@ -40,12 +40,12 @@ if args.noop: puppet_cmd += ["--noop"] puppet_cmd += extra_args -# Set the scripts path to be a factor so it can be used by puppet code +# Set the scripts path to be a factor so it can be used by Puppet code puppet_env = os.environ.copy() puppet_env["FACTER_zulip_conf_path"] = args.config puppet_env["FACTER_zulip_scripts_path"] = scripts_path -# This is to suppress puppet warnings with ruby 2.7. +# This is to suppress Puppet warnings with ruby 2.7. if (distro_info['ID'], distro_info['VERSION_ID']) in [('ubuntu', '20.04')]: puppet_env["RUBYOPT"] = "-W0" diff --git a/static/assets/zulip-emoji/README b/static/assets/zulip-emoji/README index 2208fa6606..51ddf9f520 100644 --- a/static/assets/zulip-emoji/README +++ b/static/assets/zulip-emoji/README @@ -3,7 +3,7 @@ about Noto, please refer to: https://code.google.com/p/noto/ -These images were generated from the git repository at +These images were generated from the Git repository at-
{{#each users}}
{{> typing_notification}}
diff --git a/static/templates/user_presence_rows.hbs b/static/templates/user_presence_rows.hbs
index 9a13d564bb..211de70977 100644
--- a/static/templates/user_presence_rows.hbs
+++ b/static/templates/user_presence_rows.hbs
@@ -1,4 +1,4 @@
-{{! User Presence rows }}
+{{! User presence rows }}
{{#each users}}
{{> user_presence_row}}
{{/each}}
diff --git a/static/templates/widgets/tictactoe_widget.hbs b/static/templates/widgets/tictactoe_widget.hbs
index 2259926b87..0fad0955dc 100644
--- a/static/templates/widgets/tictactoe_widget.hbs
+++ b/static/templates/widgets/tictactoe_widget.hbs
@@ -1,4 +1,4 @@
-
Tic Tac Toe
+Tic-tac-toe
{{ move_status }}
diff --git a/static/third/marked/lib/marked.js b/static/third/marked/lib/marked.js index a8fd74bbba..609cfa6337 100644 --- a/static/third/marked/lib/marked.js +++ b/static/third/marked/lib/marked.js @@ -645,7 +645,7 @@ InlineLexer.prototype.output = function(src) { continue; } - // realm_filters (zulip) + // realm_filters (Zulip) var self = this; this.rules.realm_filters.forEach(function (realm_filter) { var ret = self.inlineReplacement(realm_filter, src, function(regex, groups, match) { @@ -740,28 +740,28 @@ InlineLexer.prototype.output = function(src) { continue; } - // usermention (zulip) + // usermention (Zulip) if (cap = this.rules.usermention.exec(src)) { src = src.substring(cap[0].length); out += this.usermention(unescape(cap[3] || cap[4]), cap[1], cap[2]); continue; } - // groupmention (zulip) + // groupmention (Zulip) if (cap = this.rules.groupmention.exec(src)) { src = src.substring(cap[0].length); out += this.groupmention(unescape(cap[1]), cap[0]); continue; } - // stream_topic (zulip) + // stream_topic (Zulip) if (cap = this.rules.stream_topic.exec(src)) { src = src.substring(cap[0].length); out += this.stream_topic(unescape(cap[1]), unescape(cap[2]), cap[0]); continue; } - // stream (zulip) + // stream (Zulip) if (cap = this.rules.stream.exec(src)) { src = src.substring(cap[0].length); out += this.stream(unescape(cap[1]), cap[0]); @@ -810,7 +810,7 @@ InlineLexer.prototype.output = function(src) { continue; } - // unicode emoji + // Unicode emoji if (cap = this.rules.unicodeemoji.exec(src)) { src = src.substring(cap[0].length); out += this.unicodeEmoji(cap[1]); diff --git a/stubs/taint/false_positives.pysa b/stubs/taint/false_positives.pysa index d4e1ef8cfd..ad5c356099 100644 --- a/stubs/taint/false_positives.pysa +++ b/stubs/taint/false_positives.pysa @@ -39,7 +39,7 @@ def zerver.lib.actions.create_user_messages( def zerver.lib.pysa.mark_sanitized(arg) -> Sanitize: ... ############################ -# Overbroad Approximations # +# Overbroad approximations # ############################ # Note that the below functions are overbroad approximations of Sanitizers and diff --git a/templates/analytics/activity.html b/templates/analytics/activity.html index d8ab78b27a..0beb074710 100644 --- a/templates/analytics/activity.html +++ b/templates/analytics/activity.html @@ -1,7 +1,7 @@ {% extends "zerver/base.html" %} {% set entrypoint = "activity" %} -{# User Activity. #} +{# User activity. #} {% block title %}
{{ _("Last update") }}:
-
+
diff --git a/templates/analytics/support.html b/templates/analytics/support.html index c9ce11190c..afee21debc 100644 --- a/templates/analytics/support.html +++ b/templates/analytics/support.html @@ -1,7 +1,7 @@ {% extends "zerver/base.html" %} {% set entrypoint = "support" %} -{# User Activity. #} +{# User activity. #} {% block title %}Info
@@ -13,7 +13,7 @@
diff --git a/templates/corporate/billing.html b/templates/corporate/billing.html index efb6116c9a..7709a0992c 100644 --- a/templates/corporate/billing.html +++ b/templates/corporate/billing.html @@ -22,7 +22,7 @@ {% if admin_access and has_active_plan %} diff --git a/templates/corporate/zephyr-mirror.html b/templates/corporate/zephyr-mirror.html index 697d027653..de2c445cd9 100644 --- a/templates/corporate/zephyr-mirror.html +++ b/templates/corporate/zephyr-mirror.html @@ -1,6 +1,6 @@ {% extends "zerver/portico.html" %} -{# Zephyr Mirroring information page #} +{# Zephyr mirroring information page #} {% block portico_content %}
- diff --git a/templates/analytics/support.html b/templates/analytics/support.html index c9ce11190c..afee21debc 100644 --- a/templates/analytics/support.html +++ b/templates/analytics/support.html @@ -1,7 +1,7 @@ {% extends "zerver/base.html" %} {% set entrypoint = "support" %} -{# User Activity. #} +{# User activity. #} {% block title %}
diff --git a/templates/corporate/billing.html b/templates/corporate/billing.html index efb6116c9a..7709a0992c 100644 --- a/templates/corporate/billing.html +++ b/templates/corporate/billing.html @@ -22,7 +22,7 @@ {% if admin_access and has_active_plan %} diff --git a/templates/corporate/zephyr-mirror.html b/templates/corporate/zephyr-mirror.html index 697d027653..de2c445cd9 100644 --- a/templates/corporate/zephyr-mirror.html +++ b/templates/corporate/zephyr-mirror.html @@ -1,6 +1,6 @@ {% extends "zerver/portico.html" %} -{# Zephyr Mirroring information page #} +{# Zephyr mirroring information page #} {% block portico_content %}
The Zephyr mirror script (not recommended)
@@ -52,7 +52,7 @@ mirror script instead of using Webathena. -This will run the Zephyr Mirroring script inside a screen +
This will run the Zephyr mirroring script inside a screen
session, and use `/mit/kchen/bin/cont-renew-notify` to continually
renew your Kerberos tickets for up to a week; each week, it will
send you a Zephyr/Zulip letting you know that you need to renew
diff --git a/templates/zerver/api/changelog.md b/templates/zerver/api/changelog.md
index d8eff38c30..8c676362c7 100644
--- a/templates/zerver/api/changelog.md
+++ b/templates/zerver/api/changelog.md
@@ -42,7 +42,7 @@ Note that as of this feature level, stream administrators are a
partially completed feature. In particular, it is impossible for a
user to be a stream administrator at this feature level.
-**Feature Level 30**
+**Feature level 30**
* [`GET users/me/subscriptions`](/api/get-subscriptions), [`GET
/streams`](/api/get-streams): Added `date_created` to Stream
@@ -259,7 +259,7 @@ No changes; feature level used for Zulip 3.0 release.
* [`POST /messages/{message_id}/reactions`](/api/add-reaction):
The `reaction_type` parameter is optional; the server will guess the
`reaction_type` if it is not specified (checking custom emoji, then
- unicode emoji for any with the provided name).
+ Unicode emoji for any with the provided name).
* `reactions` objects returned by the API (both in `GET /messages` and
in `GET /events`) now include the user who reacted in a top-level
`user_id` field. The legacy `user` dictionary (which had
@@ -283,7 +283,7 @@ No changes; feature level used for Zulip 3.0 release.
* [`GET /messages`](/api/get-messages) and [`GET
/events`](/api/get-events): Message objects now use
`topic_links` rather than `subject_links` to indicate links either
- present in the topic or generated by Linkifiers applied to the topic.
+ present in the topic or generated by linkifiers applied to the topic.
* [`POST /users/me/subscriptions`](/api/subscribe): Replaced
`is_announcement_only` boolean with `stream_post_policy` enum for
specifying who can post to a stream.
diff --git a/templates/zerver/api/configuring-python-bindings.md b/templates/zerver/api/configuring-python-bindings.md
index 81a97a73d1..d5b51b43c1 100644
--- a/templates/zerver/api/configuring-python-bindings.md
+++ b/templates/zerver/api/configuring-python-bindings.md
@@ -17,7 +17,7 @@ A `.zuliprc` file is a plain text document that looks like this:
```
[api]
-key= Track issues and pull requests
-
diff --git a/templates/zerver/help/change-a-users-role.md b/templates/zerver/help/change-a-users-role.md
index 4b7f731c75..0387e6d1fd 100644
--- a/templates/zerver/help/change-a-users-role.md
+++ b/templates/zerver/help/change-a-users-role.md
@@ -11,7 +11,7 @@ organization administrator can change the role of most users, but
cannot create or demote an organization owner.
You can can revoke your own owner or administrative privileges if
-there is at least one other owner in the organization (Consider
+there is at least one other owner in the organization (consider
promoting a new owner or [deactivating the
organization](/help/deactivate-your-organization) instead).
diff --git a/templates/zerver/help/import-from-gitter.md b/templates/zerver/help/import-from-gitter.md
index 63deefc696..a8c8387690 100644
--- a/templates/zerver/help/import-from-gitter.md
+++ b/templates/zerver/help/import-from-gitter.md
@@ -21,9 +21,9 @@ First, export your data from Gitter.
Zulip.
!!! warn ""
- **Note:** You'll need a gitter API token to export data. You can get this
+ **Note:** You'll need a Gitter API token to export data. You can get this
token by following the instructions in the "**Getting Started**" section of the
- [gitter documentation](https://developer.gitter.im/docs/).
+ [Gitter documentation](https://developer.gitter.im/docs/).
{end_tabs}
@@ -90,7 +90,7 @@ to mark the appropriate users as administrators.
## Caveats
- The [Gitter data export tool](https://github.com/minrk/archive-gitter)
- doesn't support exporting private gitter channels.
+ doesn't support exporting private Gitter channels.
- Gitter's export tool doesn't export email addresses; just GitHub
usernames. The import tool will thus use [GitHub's generated
diff --git a/templates/zerver/help/import-from-hipchat.md b/templates/zerver/help/import-from-hipchat.md
index b0a1259b58..bfef4f9992 100644
--- a/templates/zerver/help/import-from-hipchat.md
+++ b/templates/zerver/help/import-from-hipchat.md
@@ -37,7 +37,7 @@ admin console.
1. Upgrade to the latest version to ensure you have the latest updates to
the HipChat export dashboard.
-1. Log in at the domain name configured for your Hipchat Server.
+1. Log in at the domain name configured for your HipChat Server.
1. Click on **Server Admin > Export**.
@@ -51,7 +51,7 @@ Once the export has completed, you will receive an **email** with a link to
download the file.
!!! tip ""
- If you are not on the latest version of Hipchat Server / Data Center,
+ If you are not on the latest version of HipChat Server / Data Center,
you can do a command line export with `hipchat export --export`. See
HipChat's [command line export docs][cli-export] for more information.
diff --git a/templates/zerver/help/import-from-mattermost.md b/templates/zerver/help/import-from-mattermost.md
index 7eba2834ea..67848d41f7 100644
--- a/templates/zerver/help/import-from-mattermost.md
+++ b/templates/zerver/help/import-from-mattermost.md
@@ -109,7 +109,7 @@ Replace `
- Github
+
+ GitHub
Integrations Developer Panel
+ Integrations developer panel
Go to Zulip
diff --git a/templates/zerver/integrations/discourse.md b/templates/zerver/integrations/discourse.md
index 1123baae8f..972411ee55 100644
--- a/templates/zerver/integrations/discourse.md
+++ b/templates/zerver/integrations/discourse.md
@@ -13,7 +13,7 @@ key to third-party services.
Copy the `USERNAME` and `API KEY` - you'll need it later.
Head over to the
-[Discourse Chat Integration Setup Instructions](https://meta.discourse.org/t/68501)
+[discourse-chat-integration setup instructions](https://meta.discourse.org/t/68501)
and complete them.
{!congrats.md!}
diff --git a/templates/zerver/integrations/git.md b/templates/zerver/integrations/git.md
index 6072fb1678..1ebda3f5c5 100644
--- a/templates/zerver/integrations/git.md
+++ b/templates/zerver/integrations/git.md
@@ -16,10 +16,10 @@ Get Zulip notifications for your Git repositories!
notification.
1. Symlink `/usr/local/share/zulip/integrations/git/zulip_git_config.py`
- to the `.git/hooks` directory of your git repository.
+ to the `.git/hooks` directory of your Git repository.
1. Symlink `/usr/local/share/zulip/integrations/git/post-receive`
- to the `.git/hooks` directory of your git repository.
+ to the `.git/hooks` directory of your Git repository.
!!! tip ""
diff --git a/templates/zerver/integrations/google-calendar.md b/templates/zerver/integrations/google-calendar.md
index 0b356f7ca7..62e0fa489b 100644
--- a/templates/zerver/integrations/google-calendar.md
+++ b/templates/zerver/integrations/google-calendar.md
@@ -14,7 +14,7 @@ to your `~/` directory.
Next, install the latest Google API Client for Python by following the
instructions on the
-[Google Website](https://developers.google.com/api-client-library/python/start/installation).
+[Google website](https://developers.google.com/api-client-library/python/start/installation).
Then go to your **Zulip Settings** by clicking on the cog in the top
right corner, and then clicking on **Settings**.
@@ -46,7 +46,7 @@ There are two optional flags that you can specify when running this
script:
* `--calendar`: This flag specifies the calendar to watch from the
- user’s Google Account. By default, this flag is set to a user’s
+ user’s Google account. By default, this flag is set to a user’s
primary or default calendar. To specify a calendar, you need the
calendar ID which can be obtained by going to Google Calendar and
clicking on the wedge next to the calendar’s name. Click on settings
diff --git a/templates/zerver/integrations/jira-plugin.md b/templates/zerver/integrations/jira-plugin.md
index 784a647d9c..2cadec2303 100644
--- a/templates/zerver/integrations/jira-plugin.md
+++ b/templates/zerver/integrations/jira-plugin.md
@@ -9,7 +9,7 @@ versions of JIRA.*
{!download-python-bindings.md!}
-#### Plugin Installation
+#### Plugin installation
The JIRA integration plugin requires two JIRA plugins. Please install
the following plugins using the **Universal Plugin Manager** in your
@@ -21,7 +21,7 @@ JIRA installation:
[script-runner]: https://marketplace.atlassian.com/plugins/com.onresolve.jira.groovy.groovyrunner
[ssl-plugin]: https://marketplace.atlassian.com/plugins/com.atlassian.jira.plugin.jirasslplugin
-#### SSL Setup
+#### SSL setup
As Zulip is using a StartCOM SSL certificate that is not recognized by
default in the Java installation shipped with JIRA, you will need to
@@ -34,7 +34,7 @@ tell JIRA about the certificate.
instructions and restart JIRA for it to recognize the proper
certificates.
-#### Zulip Integration
+#### Zulip integration
1. Copy the folder `integrations/jira/org/` (from the tarball you
downloaded above) to your JIRA `classes` folder. For self-contained
diff --git a/templates/zerver/portico-header.html b/templates/zerver/portico-header.html
index 4fbc2538c8..4d312db38e 100644
--- a/templates/zerver/portico-header.html
+++ b/templates/zerver/portico-header.html
@@ -9,10 +9,10 @@
.zulipdev.org` on the command line
(Terminal for macOS and Linux, Bash for Git on Windows).
-- There is no password; your account is configured to use your ssh keys.
+- There is no password; your account is configured to use your SSH keys.
- Once you log in, you should see `(zulip-py3-venv) ~$`.
- To start the dev server, `cd zulip` and then run `./tools/run-dev.py`.
- While the dev server is running, you can see the Zulip server in your browser
@@ -131,7 +131,7 @@ Rough steps:
1. `tools/provision`
1. `git clean -f`, in case things were added/removed from `.gitignore`.
1. `tools/run-dev.py`, let it run to completion, and then Ctrl-C (to clear
- out anything in the Rabbit MQ queue, load messages, etc).
+ out anything in the RabbitMQ queue, load messages, etc).
1. `tools/run-dev.py`, and check that `base.zulipdev.org:9991` is up and running.
1. `> ~/.bash_history && history -c && sudo shutdown -h now` to clear any command
line history (To reduce chance of confusing new contributors in case you made a typo)
@@ -192,7 +192,7 @@ Rough steps:
## Remotely debugging a droplet
To SSH into a droplet, first make sure you have a SSH key associated with your
-github account, then ask the student to run the following in their
+GitHub account, then ask the student to run the following in their
VM:
```
diff --git a/tools/droplets/add_mentor.py b/tools/droplets/add_mentor.py
index 488908bb31..1b408edb9d 100644
--- a/tools/droplets/add_mentor.py
+++ b/tools/droplets/add_mentor.py
@@ -5,7 +5,7 @@
#
# $ python3 add_mentor.py
#
-# Alternatively you can pass in --remove to remove their ssh key from the
+# Alternatively you can pass in --remove to remove their SSH key from the
# machine:
#
# $ python3 add_mentor.py --remove
@@ -19,7 +19,7 @@ from typing import List
import requests
parser = ArgumentParser(description='Give a mentor ssh access to this machine.')
-parser.add_argument('username', help='Github username of the mentor.')
+parser.add_argument('username', help='GitHub username of the mentor.')
parser.add_argument('--remove', help='Remove his/her key from the machine.',
action='store_true')
@@ -35,7 +35,7 @@ def get_mentor_keys(username: str) -> List[str]:
r = requests.get(url)
if r.status_code != 200:
- print('Cannot connect to Github...')
+ print('Cannot connect to GitHub...')
sys.exit(1)
keys = r.json()
diff --git a/tools/droplets/create.py b/tools/droplets/create.py
index 20ce311a45..8863b5e613 100644
--- a/tools/droplets/create.py
+++ b/tools/droplets/create.py
@@ -8,10 +8,10 @@
# Requires python-digitalocean library:
# https://github.com/koalalorenzo/python-digitalocean
#
-# Also requires DigitalOcean team membership for Zulip and api token:
+# Also requires DigitalOcean team membership for Zulip and API token:
# https://cloud.digitalocean.com/settings/api/tokens
#
-# Copy conf.ini-template to conf.ini and populate with your api token.
+# Copy conf.ini-template to conf.ini and populate with your API token.
#
# usage: python3 create.py
import argparse
@@ -28,7 +28,7 @@ import digitalocean
# initiation argument parser
parser = argparse.ArgumentParser(description='Create a Zulip devopment VM DigitalOcean droplet.')
-parser.add_argument("username", help="Github username for whom you want to create a Zulip dev droplet")
+parser.add_argument("username", help="GitHub username for whom you want to create a Zulip dev droplet")
parser.add_argument('--tags', nargs='+', default=[])
parser.add_argument('-f', '--recreate', action="store_true")
@@ -47,7 +47,7 @@ def user_exists(username: str) -> bool:
return True
except urllib.error.HTTPError as err:
print(err)
- print(f"Does the github user {username} exist?")
+ print(f"Does the GitHub user {username} exist?")
sys.exit(1)
def get_keys(username: str) -> List[Dict[str, Any]]:
@@ -57,13 +57,13 @@ def get_keys(username: str) -> List[Dict[str, Any]]:
response = urllib.request.urlopen(apiurl_keys)
userkeys = json.load(response)
if not userkeys:
- print(f"No keys found. Has user {username} added ssh keys to their github account?")
+ print(f"No keys found. Has user {username} added SSH keys to their GitHub account?")
sys.exit(1)
print("...public keys found!")
return userkeys
except urllib.error.HTTPError as err:
print(err)
- print(f"Has user {username} added ssh keys to their github account?")
+ print(f"Has user {username} added SSH keys to their GitHub account?")
sys.exit(1)
def fork_exists(username: str) -> bool:
@@ -199,7 +199,7 @@ Your remote Zulip dev server has been created!
- Connect to your server by running
`ssh zulipdev@{0}.zulipdev.org` on the command line
(Terminal for macOS and Linux, Bash for Git on Windows).
-- There is no password; your account is configured to use your ssh keys.
+- There is no password; your account is configured to use your SSH keys.
- Once you log in, you should see `(zulip-py3-venv) ~$`.
- To start the dev server, `cd zulip` and then run `./tools/run-dev.py`.
- While the dev server is running, you can see the Zulip server in your browser at
diff --git a/tools/fetch-contributor-data b/tools/fetch-contributor-data
index 69fc38716d..520771ac7d 100755
--- a/tools/fetch-contributor-data
+++ b/tools/fetch-contributor-data
@@ -1,6 +1,6 @@
#!/usr/bin/env python3
"""
-Fetch contributors data from Github using their API, convert it to structured
+Fetch contributors data from GitHub using their API, convert it to structured
JSON data for the /team page contributors section.
"""
import os
@@ -37,7 +37,7 @@ duplicate_commits_file = os.path.join(os.path.dirname(__file__), 'duplicate_comm
parser = argparse.ArgumentParser()
parser.add_argument('--max-retries', type=int, default=10,
- help='Number of times to retry fetching data from Github')
+ help='Number of times to retry fetching data from GitHub')
args = parser.parse_args()
class ContributorsJSON(TypedDict):
@@ -78,7 +78,7 @@ def fetch_contributors(repo_name: str, max_retries: int) -> List[Contributor]:
else:
retry_attempts += 1
if retry_attempts > args.max_retries:
- logger.warning("Failed retries fetching contributors data from Github.")
+ logger.warning("Failed retries fetching contributors data from GitHub.")
sys.exit(1)
sleep_time = randrange(0, min(64, 2**retry_attempts))
diff --git a/tools/lib/provision.py b/tools/lib/provision.py
index e9431be385..f4eef30c01 100755
--- a/tools/lib/provision.py
+++ b/tools/lib/provision.py
@@ -40,7 +40,7 @@ VAR_DIR_PATH = os.path.join(ZULIP_PATH, 'var')
CONTINUOUS_INTEGRATION = 'GITHUB_ACTIONS' in os.environ or 'CIRCLECI' in os.environ
if not os.path.exists(os.path.join(ZULIP_PATH, ".git")):
- print(FAIL + "Error: No Zulip git repository present!" + ENDC)
+ print(FAIL + "Error: No Zulip Git repository present!" + ENDC)
print("To set up the Zulip development environment, you should clone the code")
print("from GitHub, rather than using a Zulip production release tarball.")
sys.exit(1)
@@ -159,13 +159,13 @@ COMMON_YUM_DEPENDENCIES = [
BUILD_PGROONGA_FROM_SOURCE = False
if vendor == 'debian' and os_version in [] or vendor == 'ubuntu' and os_version in []:
- # For platforms without a pgroonga release, we need to build it
+ # For platforms without a PGroonga release, we need to build it
# from source.
BUILD_PGROONGA_FROM_SOURCE = True
SYSTEM_DEPENDENCIES = [
*UBUNTU_COMMON_APT_DEPENDENCIES,
f"postgresql-{POSTGRES_VERSION}",
- # Dependency for building pgroonga from source
+ # Dependency for building PGroonga from source
f"postgresql-server-dev-{POSTGRES_VERSION}",
"libgroonga-dev",
"libmsgpack-dev",
@@ -195,7 +195,7 @@ elif "fedora" in os_families():
f"postgresql{POSTGRES_VERSION}-server",
f"postgresql{POSTGRES_VERSION}",
f"postgresql{POSTGRES_VERSION}-devel",
- # Needed to build pgroonga from source
+ # Needed to build PGroonga from source
"groonga-devel",
"msgpack-devel",
*VENV_DEPENDENCIES,
@@ -227,7 +227,7 @@ def install_system_deps() -> None:
else:
raise AssertionError("Invalid vendor")
- # For some platforms, there aren't published pgroonga
+ # For some platforms, there aren't published PGroonga
# packages available, so we build them from source.
if BUILD_PGROONGA_FROM_SOURCE:
run_as_root(["./scripts/lib/build-pgroonga"])
@@ -279,13 +279,13 @@ def install_yum_deps(deps_to_install: List[str]) -> None:
run_as_root(["ln", "-nsf", "/usr/bin/python36", "/usr/bin/python3"])
postgres_dir = f'pgsql-{POSTGRES_VERSION}'
for cmd in ['pg_config', 'pg_isready', 'psql']:
- # Our tooling expects these postgres scripts to be at
+ # Our tooling expects these Postgres scripts to be at
# well-known paths. There's an argument for eventually
# making our tooling auto-detect, but this is simpler.
run_as_root(["ln", "-nsf", f"/usr/{postgres_dir}/bin/{cmd}",
f"/usr/bin/{cmd}"])
- # From here, we do the first-time setup/initialization for the postgres database.
+ # From here, we do the first-time setup/initialization for the Postgres database.
pg_datadir = f"/var/lib/pgsql/{POSTGRES_VERSION}/data"
pg_hba_conf = os.path.join(pg_datadir, "pg_hba.conf")
@@ -300,7 +300,7 @@ def install_yum_deps(deps_to_install: List[str]) -> None:
sudo_args = ['-H'])
# Use vendored pg_hba.conf, which enables password authentication.
run_as_root(["cp", "-a", "puppet/zulip/files/postgresql/centos_pg_hba.conf", pg_hba_conf])
- # Later steps will ensure postgres is started
+ # Later steps will ensure Postgres is started
# Link in tsearch data files
overwrite_symlink(
@@ -329,7 +329,7 @@ def main(options: argparse.Namespace) -> "NoReturn":
# hash the content of setup-yum-repo*
sha_sum.update(open('scripts/lib/setup-yum-repo', 'rb').read())
- # hash the content of build-pgroonga if pgroonga is built from source
+ # hash the content of build-pgroonga if PGroonga is built from source
if BUILD_PGROONGA_FROM_SOURCE:
sha_sum.update(open('scripts/lib/build-pgroonga', 'rb').read())
diff --git a/tools/run-dev.py b/tools/run-dev.py
index 145b8774a3..a2d5ded111 100755
--- a/tools/run-dev.py
+++ b/tools/run-dev.py
@@ -85,7 +85,7 @@ base_port = 9991
if options.test:
base_port = 9981
settings_module = "zproject.test_settings"
- # Don't auto-reload when running puppeteer tests
+ # Don't auto-reload when running Puppeteer tests
runserver_args = ['--noreload']
else:
settings_module = "zproject.settings"
@@ -159,7 +159,7 @@ def server_processes() -> List[List[str]]:
def do_one_time_webpack_compile() -> None:
# We just need to compile webpack assets once at startup, not run a daemon,
# in test mode. Additionally, webpack-dev-server doesn't support running 2
- # copies on the same system, so this model lets us run the puppeteer tests
+ # copies on the same system, so this model lets us run the Puppeteer tests
# with a running development server.
subprocess.check_call(['./tools/webpack', '--quiet', '--test'])
diff --git a/tools/setup/dev-vagrant-docker/Dockerfile b/tools/setup/dev-vagrant-docker/Dockerfile
index 96dcdfa5fb..488aaacf52 100644
--- a/tools/setup/dev-vagrant-docker/Dockerfile
+++ b/tools/setup/dev-vagrant-docker/Dockerfile
@@ -28,7 +28,7 @@ ARG VAGRANT_UID
RUN \
# We use https://github.com/gdraheim/docker-systemctl-replacement
- # to make services we install like postgres, redis, etc. normally
+ # to make services we install like Postgres, Redis, etc. normally
# managed by systemd start within Docker, which breaks normal
# operation of systemd.
dpkg-divert --add --rename /bin/systemctl \
diff --git a/tools/setup/emoji/build_emoji b/tools/setup/emoji/build_emoji
index 98b185ac0e..33b7ab558d 100755
--- a/tools/setup/emoji/build_emoji
+++ b/tools/setup/emoji/build_emoji
@@ -82,7 +82,7 @@ def main() -> None:
if not os.access(EMOJI_CACHE_PATH, os.W_OK):
# Note: In production, this block will fail, since we don't
# assume sudo access; but it should never run in production
- # anyway, because EMOJI_CACHE_PATH is created by puppet before
+ # anyway, because EMOJI_CACHE_PATH is created by Puppet before
# build_emoji would be run.
run_as_root(["mkdir", "-p", EMOJI_CACHE_PATH])
run_as_root(["chown", f"{os.getuid()}:{os.getgid()}", EMOJI_CACHE_PATH])
@@ -167,7 +167,7 @@ def generate_sprite_css_files(cache_path: str,
# emoji_is_universal? Because we briefly supported all
# Google emoji (not just the universal ones), we need to
# ensure the spritesheet is set up to correctly display
- # those google emoji (in case anyone used them).
+ # those Google emoji (in case anyone used them).
"""
For background-position we need to use percentages.
@@ -280,7 +280,7 @@ def setup_emoji_farms(cache_path: str, emoji_data: List[Dict[str, Any]]) -> None
for emojiset in ['google', 'twitter']:
setup_emoji_farm(emojiset, emoji_data)
- # Set up old google "blobs" emojiset.
+ # Set up old Google "blobs" emojiset.
GOOGLE_BLOB_EMOJI_DATA_PATH = os.path.join(NODE_MODULES_PATH,
'emoji-datasource-google-blob',
'emoji.json')
diff --git a/tools/setup/emoji/emoji_names.py b/tools/setup/emoji/emoji_names.py
index 23c007ab75..6b52e10db4 100644
--- a/tools/setup/emoji/emoji_names.py
+++ b/tools/setup/emoji/emoji_names.py
@@ -4,10 +4,10 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
# seems like best emoji for happy
'1f600': {'canonical_name': 'grinning', 'aliases': ['happy']},
'1f603': {'canonical_name': 'smiley', 'aliases': []},
- # the google emoji for this is not great, so made People/9 'smile' and
+ # the Google emoji for this is not great, so made People/9 'smile' and
# renamed this one
'1f604': {'canonical_name': 'big_smile', 'aliases': []},
- # from gemoji/unicode
+ # from gemoji/Unicode
'1f601': {'canonical_name': 'grinning_face_with_smiling_eyes', 'aliases': []},
# satisfied doesn't seem like a good description of these images
'1f606': {'canonical_name': 'laughing', 'aliases': ['lol']},
@@ -18,7 +18,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
# not sure how the glyphs match relaxed, but both iamcal and gemoji have it
'263a': {'canonical_name': 'smiling_face', 'aliases': ['relaxed']},
'1f60a': {'canonical_name': 'blush', 'aliases': []},
- # halo comes from gemoji/unicode
+ # halo comes from gemoji/Unicode
'1f607': {'canonical_name': 'innocent', 'aliases': ['halo']},
'1f642': {'canonical_name': 'smile', 'aliases': []},
'1f643': {'canonical_name': 'upside_down', 'aliases': ['oops']},
@@ -55,7 +55,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
'1f614': {'canonical_name': 'pensive', 'aliases': ['tired']},
'1f61f': {'canonical_name': 'worried', 'aliases': []},
# these seem to better capture the glyphs. This is also what :/ turns into
- # in google hangouts
+ # in Google Hangouts
'1f615': {'canonical_name': 'oh_no', 'aliases': ['half_frown', 'concerned', 'confused']},
'1f641': {'canonical_name': 'frown', 'aliases': ['slight_frown']},
# sad seemed better than putting another frown as the primary name (see
@@ -88,7 +88,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
'1f632': {'canonical_name': 'astonished', 'aliases': []},
'1f635': {'canonical_name': 'dizzy', 'aliases': []},
# the alternates are from https://emojipedia.org/flushed-face/. shame
- # doesn't work with the google emoji
+ # doesn't work with the Google emoji
'1f633': {'canonical_name': 'flushed', 'aliases': ['embarrassed', 'blushing']},
'1f631': {'canonical_name': 'scream', 'aliases': []},
# scared from https://emojipedia.org/fearful-face/, shock seemed like a
@@ -129,13 +129,13 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
# hurt)
'1f915': {'canonical_name': 'hurt', 'aliases': ['head_bandage', 'injured']},
# devil from https://emojipedia.org/smiling-face-with-horns/,
- # smiling_face_with_horns from gemoji/unicode
+ # smiling_face_with_horns from gemoji/Unicode
'1f608': {'canonical_name': 'smiling_devil', 'aliases': ['smiling_imp', 'smiling_face_with_horns']},
# angry_devil from https://beebom.com/emoji-meanings/
'1f47f': {'canonical_name': 'devil', 'aliases': ['imp', 'angry_devil']},
'1f479': {'canonical_name': 'ogre', 'aliases': []},
'1f47a': {'canonical_name': 'goblin', 'aliases': []},
- # pile_of_poo from gemoji/unicode
+ # pile_of_poo from gemoji/Unicode
'1f4a9': {'canonical_name': 'poop', 'aliases': ['pile_of_poo']},
# alternates seemed like reasonable additions
'1f47b': {'canonical_name': 'ghost', 'aliases': ['boo', 'spooky', 'haunted']},
@@ -155,7 +155,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
# smug_cat to parallel People/31
'1f63c': {'canonical_name': 'smirk_cat', 'aliases': ['smug_cat']},
'1f63d': {'canonical_name': 'kissing_cat', 'aliases': []},
- # weary_cat from unicode/gemoji
+ # weary_cat from Unicode/gemoji
'1f640': {'canonical_name': 'scream_cat', 'aliases': ['weary_cat']},
'1f63f': {'canonical_name': 'crying_cat', 'aliases': []},
# angry_cat to better parallel People/45
@@ -209,19 +209,19 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
# due to 'high_five'
'1f44b': {'canonical_name': 'wave', 'aliases': ['hello', 'hi']},
'1f919': {'canonical_name': 'call_me', 'aliases': []},
- # flexed_biceps from gemoji/unicode, strong seemed like a good addition
+ # flexed_biceps from gemoji/Unicode, strong seemed like a good addition
'1f4aa': {'canonical_name': 'muscle', 'aliases': []},
'1f595': {'canonical_name': 'middle_finger', 'aliases': []},
'270d': {'canonical_name': 'writing', 'aliases': []},
'1f933': {'canonical_name': 'selfie', 'aliases': []},
- # Couldn't figure out why iamcal chose nail_care. unicode uses nail_polish,
+ # Couldn't figure out why iamcal chose nail_care. Unicode uses nail_polish,
# gemoji uses both
'1f485': {'canonical_name': 'nail_polish', 'aliases': ['nail_care']},
'1f48d': {'canonical_name': 'ring', 'aliases': []},
'1f484': {'canonical_name': 'lipstick', 'aliases': []},
# People/18 seems like a better kiss for most circumstances
'1f48b': {'canonical_name': 'lipstick_kiss', 'aliases': []},
- # mouth from gemoji/unicode
+ # mouth from gemoji/Unicode
'1f444': {'canonical_name': 'lips', 'aliases': ['mouth']},
'1f445': {'canonical_name': 'tongue', 'aliases': []},
'1f442': {'canonical_name': 'ear', 'aliases': []},
@@ -244,7 +244,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
# It's used on twitter a bunch, either when showing off hair, or in a way
# where People/144 would substitute. It'd be nice if there were another
# emoji one could use for "good hair", but I think not a big loss to not
- # have one for zulip, and not worth the eurocentrism.
+ # have one for Zulip, and not worth the eurocentrism.
# '1f471': {'canonical_name': 'X', 'aliases': ['person_with_blond_hair']},
# Added elderly since I think some people prefer that term
'1f474': {'canonical_name': 'older_man', 'aliases': ['elderly_man']},
@@ -252,7 +252,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
'1f475': {'canonical_name': 'older_woman', 'aliases': ['elderly_woman']},
'1f472': {'canonical_name': 'gua_pi_mao', 'aliases': []},
'1f473': {'canonical_name': 'turban', 'aliases': []},
- # police seems like a more polite term, and matches the unicode
+ # police seems like a more polite term, and matches the Unicode
'1f46e': {'canonical_name': 'police', 'aliases': ['cop']},
'1f477': {'canonical_name': 'construction_worker', 'aliases': []},
'1f482': {'canonical_name': 'guard', 'aliases': []},
@@ -328,7 +328,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
# https://mashable.com/2015/10/23/ios-9-1-emoji-guide/. hard_hat and
# rescue_worker seem like good additions
'26d1': {'canonical_name': 'helmet', 'aliases': ['hard_hat', 'rescue_worker', 'safety_first', 'invincible']},
- # backpack from gemoji, dominates satchel on google trends
+ # backpack from gemoji, dominates satchel on Google Trends
'1f392': {'canonical_name': 'backpack', 'aliases': ['satchel']},
'1f45d': {'canonical_name': 'pouch', 'aliases': []},
'1f45b': {'canonical_name': 'purse', 'aliases': []},
@@ -340,7 +340,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
'1f576': {'canonical_name': 'dark_sunglasses', 'aliases': []},
'1f302': {'canonical_name': 'closed_umbrella', 'aliases': []},
'2602': {'canonical_name': 'umbrella', 'aliases': []},
- # Some animals have a unicode codepoint "", some have a codepoint
+ # Some animals have a Unicode codepoint "", some have a codepoint
# " face", and some have both. If an animal has just a single
# codepoint, we call it , regardless of what the codepoint is. If
# an animal has both, we call the "" codepoint , and come
@@ -391,10 +391,10 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
'1f41b': {'canonical_name': 'bug', 'aliases': ['caterpillar']},
'1f98b': {'canonical_name': 'butterfly', 'aliases': []},
'1f40c': {'canonical_name': 'snail', 'aliases': []},
- # spiral_shell from unicode/gemoji, the others seemed like reasonable
+ # spiral_shell from Unicode/gemoji, the others seemed like reasonable
# additions
'1f41a': {'canonical_name': 'shell', 'aliases': ['seashell', 'conch', 'spiral_shell']},
- # unicode/gemoji have lady_beetle; hopefully with ladybug we get both the
+ # Unicode/gemoji have lady_beetle; hopefully with ladybug we get both the
# people that prefer lady_beetle (with beetle) and ladybug. There is also
# ladybird, but seems a bit much for this to complete for bird.
'1f41e': {'canonical_name': 'beetle', 'aliases': ['ladybug']},
@@ -511,11 +511,11 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
# dizzy taken by People/54, had to come up with something else
'1f4ab': {'canonical_name': 'seeing_stars', 'aliases': []},
'2b50': {'canonical_name': 'star', 'aliases': []},
- # glowing_star from gemoji/unicode
+ # glowing_star from gemoji/Unicode
'1f31f': {'canonical_name': 'glowing_star', 'aliases': []},
# glamour seems like a reasonable addition
'2728': {'canonical_name': 'sparkles', 'aliases': ['glamour']},
- # high_voltage from gemoji/unicode
+ # high_voltage from gemoji/Unicode
'26a1': {'canonical_name': 'high_voltage', 'aliases': ['zap']},
# https://emojipedia.org/fire/
'1f525': {'canonical_name': 'fire', 'aliases': ['lit', 'hot', 'flame']},
@@ -555,7 +555,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
# https://emojipedia.org/wind-blowing-face/
'1f32c': {'canonical_name': 'windy', 'aliases': ['mother_nature']},
'1f4a8': {'canonical_name': 'dash', 'aliases': []},
- # tornado_cloud comes from the unicode, but e.g. gemoji drops the cloud
+ # tornado_cloud comes from the Unicode, but e.g. gemoji drops the cloud
'1f32a': {'canonical_name': 'tornado', 'aliases': []},
# hazy seemed like a good addition
'1f32b': {'canonical_name': 'fog', 'aliases': ['hazy']},
@@ -587,7 +587,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
'1f346': {'canonical_name': 'eggplant', 'aliases': []},
'1f952': {'canonical_name': 'cucumber', 'aliases': []},
'1f955': {'canonical_name': 'carrot', 'aliases': []},
- # maize is from unicode
+ # maize is from Unicode
'1f33d': {'canonical_name': 'corn', 'aliases': ['maize']},
# chili_pepper seems like a reasonable addition
'1f336': {'canonical_name': 'hot_pepper', 'aliases': ['chili_pepper']},
@@ -632,8 +632,8 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
# seems like the best noodles? maybe this should be Foods/47? Noodles seem
# like a bigger thing in east asia than in europe, so going with that.
'1f35c': {'canonical_name': 'ramen', 'aliases': ['noodles']},
- # seems like the best :food:. Also a reasonable :soup:, though the google
- # one is indeed more a pot of food (the unicode) than a soup
+ # seems like the best :food:. Also a reasonable :soup:, though the Google
+ # one is indeed more a pot of food (the Unicode) than a soup
'1f372': {'canonical_name': 'food', 'aliases': ['soup', 'stew']},
# naruto is actual name, and I think don't need this to autocomplete for
# "fish"
@@ -687,13 +687,13 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
# Added eating_utensils so this would show up in typeahead for eat.
'1f374': {'canonical_name': 'fork_and_knife', 'aliases': ['eating_utensils']},
# Seems like the best emoji for hungry and meal. fork_and_knife_and_plate
- # is from gemoji/unicode, and I think is better than the shorter iamcal
+ # is from gemoji/Unicode, and I think is better than the shorter iamcal
# version in this case. The rest just seemed like good additions.
'1f37d': {'canonical_name': 'hungry', 'aliases': ['meal', 'table_setting', 'fork_and_knife_with_plate', 'lets_eat']},
# most people interested in this sport call it football
'26bd': {'canonical_name': 'football', 'aliases': ['soccer']},
'1f3c0': {'canonical_name': 'basketball', 'aliases': []},
- # to distinguish from Activity/1, but is also the unicode name
+ # to distinguish from Activity/1, but is also the Unicode name
'1f3c8': {'canonical_name': 'american_football', 'aliases': []},
'26be': {'canonical_name': 'baseball', 'aliases': []},
'1f3be': {'canonical_name': 'tennis', 'aliases': []},
@@ -701,9 +701,9 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
'1f3c9': {'canonical_name': 'rugby', 'aliases': []},
# https://emojipedia.org/billiards/ suggests this is actually used for
# billiards, not for "unlucky" or "losing" or some other connotation of
- # 8ball. The unicode name is billiards.
+ # 8ball. The Unicode name is billiards.
'1f3b1': {'canonical_name': 'billiards', 'aliases': ['pool', '8_ball']},
- # ping pong is the unicode name, and seems slightly more popular on
+ # ping pong is the Unicode name, and seems slightly more popular on
# https://trends.google.com/trends/explore?q=table%20tennis,ping%20pong
'1f3d3': {'canonical_name': 'ping_pong', 'aliases': ['table_tennis']},
'1f3f8': {'canonical_name': 'badminton', 'aliases': []},
@@ -732,7 +732,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
# generally than weight_lift. The others seemed like good additions.
'1f3cb': {'canonical_name': 'lift', 'aliases': ['work_out', 'weight_lift', 'gym']},
# The decisions on tenses here and in the rest of the sports section are
- # mostly from gut feel. The unicode itself is all over the place.
+ # mostly from gut feel. The Unicode itself is all over the place.
'1f93a': {'canonical_name': 'fencing', 'aliases': []},
'1f93c': {'canonical_name': 'wrestling', 'aliases': []},
# seemed like reasonable additions
@@ -763,7 +763,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
# I feel like people call sports medals "medals", and military medals
# "military medals". Also see Activity/56
'1f3c5': {'canonical_name': 'medal', 'aliases': []},
- # See Activity/55. military_medal is the gemoji/unicode
+ # See Activity/55. military_medal is the gemoji/Unicode
'1f396': {'canonical_name': 'military_medal', 'aliases': []},
# gold and number_one seem like good additions
'1f947': {'canonical_name': 'first_place', 'aliases': ['gold', 'number_one']},
@@ -802,7 +802,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
'1f3bb': {'canonical_name': 'violin', 'aliases': []},
# dice seems more useful
'1f3b2': {'canonical_name': 'dice', 'aliases': ['die']},
- # direct_hit from gemoji/unicode, and seems more useful. bulls_eye seemed
+ # direct_hit from gemoji/Unicode, and seems more useful. bulls_eye seemed
# like a reasonable addition
'1f3af': {'canonical_name': 'direct_hit', 'aliases': ['darts', 'bulls_eye']},
# strike seemed more useful than bowling
@@ -810,12 +810,12 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
'1f3ae': {'canonical_name': 'video_game', 'aliases': []},
# gambling seemed more useful than slot_machine
'1f3b0': {'canonical_name': 'slot_machine', 'aliases': []},
- # the google emoji for this is not red
+ # the Google emoji for this is not red
'1f697': {'canonical_name': 'car', 'aliases': []},
# rideshare seems like a reasonable addition
'1f695': {'canonical_name': 'taxi', 'aliases': ['rideshare']},
- # the google emoji for this is not blue. recreational_vehicle is from
- # gemoji/unicode, jeep seemed like a good addition
+ # the Google emoji for this is not blue. recreational_vehicle is from
+ # gemoji/Unicode, jeep seemed like a good addition
'1f699': {'canonical_name': 'recreational_vehicle', 'aliases': ['jeep']},
# school_bus seemed like a reasonable addition, even though the twitter
# glyph for this doesn't really look like a school bus
@@ -860,9 +860,9 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
'1f69e': {'canonical_name': 'mountain_railway', 'aliases': []},
# elevated_train seems like a reasonable addition
'1f69d': {'canonical_name': 'monorail', 'aliases': ['elevated_train']},
- # from gemoji/unicode. Also, don't thin we need two bullettrain's
+ # from gemoji/Unicode. Also, don't thin we need two bullettrain's
'1f684': {'canonical_name': 'high_speed_train', 'aliases': []},
- # google, wikipedia, etc prefer bullet train to bullettrain
+ # Google, Wikipedia, etc. prefer bullet train to bullettrain
'1f685': {'canonical_name': 'bullet_train', 'aliases': []},
'1f688': {'canonical_name': 'light_rail', 'aliases': []},
'1f682': {'canonical_name': 'train', 'aliases': ['steam_locomotive']},
@@ -899,10 +899,10 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
'2693': {'canonical_name': 'anchor', 'aliases': []},
# there already is a construction in Places/82, and work_in_progress seems
# like a useful thing to have. Construction_zone seems better than the
- # unicode construction_sign, and is there partly so this autocompletes for
+ # Unicode construction_sign, and is there partly so this autocompletes for
# construction.
'1f6a7': {'canonical_name': 'work_in_progress', 'aliases': ['construction_zone']},
- # alternates from https://emojipedia.org/fuel-pump/. unicode is fuel_pump,
+ # alternates from https://emojipedia.org/fuel-pump/. Unicode is fuel_pump,
# not fuelpump
'26fd': {'canonical_name': 'fuel_pump', 'aliases': ['gas_pump', 'petrol_pump']},
# not sure why iamcal removed the space
@@ -985,7 +985,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
# ocean_sunrise to parallel Places/109
'1f305': {'canonical_name': 'sunrise', 'aliases': ['ocean_sunrise']},
'1f304': {'canonical_name': 'mountain_sunrise', 'aliases': []},
- # shooting_star and wish seem like way better descriptions. gemoji/unicode
+ # shooting_star and wish seem like way better descriptions. gemoji/Unicode
# is shooting_star
'1f320': {'canonical_name': 'shooting_star', 'aliases': ['wish']},
'1f387': {'canonical_name': 'sparkler', 'aliases': []},
@@ -1000,16 +1000,16 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
'1f309': {'canonical_name': 'bridge', 'aliases': []},
'1f301': {'canonical_name': 'foggy', 'aliases': []},
'231a': {'canonical_name': 'watch', 'aliases': []},
- # unicode/gemoji is mobile_phone. The rest seem like good additions
+ # Unicode/gemoji is mobile_phone. The rest seem like good additions
'1f4f1': {'canonical_name': 'mobile_phone', 'aliases': ['smartphone', 'iphone', 'android']},
'1f4f2': {'canonical_name': 'calling', 'aliases': []},
- # gemoji has laptop, even though the google emoji for this does not look
+ # gemoji has laptop, even though the Google emoji for this does not look
# like a laptop
'1f4bb': {'canonical_name': 'computer', 'aliases': ['laptop']},
'2328': {'canonical_name': 'keyboard', 'aliases': []},
'1f5a5': {'canonical_name': 'desktop_computer', 'aliases': []},
'1f5a8': {'canonical_name': 'printer', 'aliases': []},
- # gemoji/unicode is computer_mouse
+ # gemoji/Unicode is computer_mouse
'1f5b1': {'canonical_name': 'computer_mouse', 'aliases': []},
'1f5b2': {'canonical_name': 'trackball', 'aliases': []},
# arcade seems like a reasonable addition
@@ -1022,7 +1022,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
'1f4be': {'canonical_name': 'floppy_disk', 'aliases': []},
'1f4bf': {'canonical_name': 'cd', 'aliases': []},
'1f4c0': {'canonical_name': 'dvd', 'aliases': []},
- # videocassette from gemoji/unicode
+ # videocassette from gemoji/Unicode
'1f4fc': {'canonical_name': 'vhs', 'aliases': ['videocassette']},
'1f4f7': {'canonical_name': 'camera', 'aliases': []},
# both of these seem more useful than camera_with_flash
@@ -1056,7 +1056,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
# seems like a reasonable addition
'1f50b': {'canonical_name': 'battery', 'aliases': ['full_battery']},
'1f50c': {'canonical_name': 'electric_plug', 'aliases': []},
- # light_bulb seems better and from unicode/gemoji. idea seems like a good
+ # light_bulb seems better and from Unicode/gemoji. idea seems like a good
# addition
'1f4a1': {'canonical_name': 'light_bulb', 'aliases': ['bulb', 'idea']},
'1f526': {'canonical_name': 'flashlight', 'aliases': []},
@@ -1143,7 +1143,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
'1f381': {'canonical_name': 'gift', 'aliases': ['present']},
# seemed like the best celebration
'1f388': {'canonical_name': 'balloon', 'aliases': ['celebration']},
- # from gemoji/unicode
+ # from gemoji/Unicode
'1f38f': {'canonical_name': 'carp_streamer', 'aliases': ['flags']},
'1f380': {'canonical_name': 'ribbon', 'aliases': ['decoration']},
'1f38a': {'canonical_name': 'confetti', 'aliases': ['party_ball']},
@@ -1198,7 +1198,7 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
'1f4d4': {'canonical_name': 'decorative_notebook', 'aliases': []},
'1f4d2': {'canonical_name': 'ledger', 'aliases': ['spiral_notebook']},
# the glyphs here are the same as Objects/147-149 (with a different color),
- # for all but google
+ # for all but Google
'1f4d5': {'canonical_name': 'red_book', 'aliases': ['closed_book']},
'1f4d7': {'canonical_name': 'green_book', 'aliases': []},
'1f4d8': {'canonical_name': 'blue_book', 'aliases': []},
@@ -1372,9 +1372,9 @@ EMOJI_NAME_MAPS: Dict[str, Dict[str, Any]] = {
'1f521': {'canonical_name': 'abcd', 'aliases': ['alphabet']},
'1f520': {'canonical_name': 'capital_abcd', 'aliases': ['capital_letters']},
'1f196': {'canonical_name': 'ng', 'aliases': []},
- # from unicode/gemoji. Saving ok for People/111
+ # from Unicode/gemoji. Saving ok for People/111
'1f197': {'canonical_name': 'squared_ok', 'aliases': []},
- # from unicode, and to parallel Symbols/135. Saving up for Symbols/171
+ # from Unicode, and to parallel Symbols/135. Saving up for Symbols/171
'1f199': {'canonical_name': 'squared_up', 'aliases': []},
'1f192': {'canonical_name': 'cool', 'aliases': []},
'1f195': {'canonical_name': 'new', 'aliases': []},
diff --git a/tools/setup/emoji/export_emoji_names_to_csv b/tools/setup/emoji/export_emoji_names_to_csv
index 93e20c04ea..0adc447729 100755
--- a/tools/setup/emoji/export_emoji_names_to_csv
+++ b/tools/setup/emoji/export_emoji_names_to_csv
@@ -118,7 +118,7 @@ def main() -> None:
with open(args.output_file_path, 'w') as f:
writer = csv.writer(f, dialect='excel')
writer.writerows(output_data)
- # The CSV file exported by google sheets doesn't have a newline
+ # The CSV file exported by Google Sheets doesn't have a newline
# character in the end. So we also strip the last newline character
# so that round-trip conversion test passes.
line_sep_len = len(os.linesep)
diff --git a/tools/setup/emoji/generate_emoji_names_table b/tools/setup/emoji/generate_emoji_names_table
index fa9cdfb998..2dee0c6c28 100755
--- a/tools/setup/emoji/generate_emoji_names_table
+++ b/tools/setup/emoji/generate_emoji_names_table
@@ -3,7 +3,7 @@
# This is a debugging tool that takes as input a bunch of different
# emoji data sources, and outputs a convenient HTML table that can be
# used to sanity-check the differences between these different data
-# sources' decisions about what names to provide to each unicode
+# sources' decisions about what names to provide to each Unicode
# codepoint.
import os
from typing import Any, Dict, List
diff --git a/tools/setup/install-aws-server b/tools/setup/install-aws-server
index d73bf81e05..c2a80414ab 100755
--- a/tools/setup/install-aws-server
+++ b/tools/setup/install-aws-server
@@ -10,7 +10,7 @@ if [ -z "$SERVER" ] || [ -z "$ROLES" ]; then
echo "Installs an empty Ubuntu server in AWS with a Zulip server role."
echo
echo " * server is the local part of the hostname (e.g. postgres0)"
- echo " * roles is a list of puppet rules to be passed to scripts/lib/install"
+ echo " * roles is a list of Puppet rules to be passed to scripts/lib/install"
echo " E.g. 'zulip::base,zulip::postgres_common'"
echo " * branch is used to override the default branch to install from."
echo
diff --git a/tools/zulip-export/zulip-export b/tools/zulip-export/zulip-export
index fdec9427ca..98dbf16ecf 100755
--- a/tools/zulip-export/zulip-export
+++ b/tools/zulip-export/zulip-export
@@ -26,7 +26,7 @@ import sys
usage = """Export all messages on a given stream to a JSON dump.
-zulip-export --user= --api-key= --stream=
+zulip-export --user= --api-key= --stream=
(You can find your API key on your Settings page.)
diff --git a/tsconfig.json b/tsconfig.json
index 3f8db10557..4d92febf7a 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -6,7 +6,7 @@
},
"types": [],
- /* Typescript 3.4 added the --incremental flag but its API is not
+ /* TypeScript 3.4 added the --incremental flag but its API is not
* currently public so ts-loader cannot use it yet.
* Tracking issue: https://github.com/microsoft/TypeScript/issues/29978
*/
diff --git a/zerver/data_import/gitter.py b/zerver/data_import/gitter.py
index 72cf1a19fe..f89f52ee1f 100644
--- a/zerver/data_import/gitter.py
+++ b/zerver/data_import/gitter.py
@@ -39,10 +39,10 @@ def gitter_workspace_to_realm(domain_name: str, gitter_data: GitterDataT,
Dict[str, int]]:
"""
Returns:
- 1. realm, Converted Realm data
- 2. avatars, which is list to map avatars to zulip avatar records.json
- 3. user_map, which is a dictionary to map from gitter user id to zulip user id
- 4. stream_map, which is a dictionary to map from gitter rooms to zulip stream id
+ 1. realm, converted realm data
+ 2. avatars, which is list to map avatars to Zulip avatar records.json
+ 3. user_map, which is a dictionary to map from Gitter user id to Zulip user id
+ 4. stream_map, which is a dictionary to map from Gitter rooms to Zulip stream id
"""
NOW = float(timezone_now().timestamp())
zerver_realm: List[ZerverFieldsT] = build_zerver_realm(realm_id, realm_subdomain, NOW, 'Gitter')
@@ -68,8 +68,8 @@ def build_userprofile(timestamp: Any, domain_name: str,
"""
Returns:
1. zerver_userprofile, which is a list of user profile
- 2. avatar_list, which is list to map avatars to zulip avatars records.json
- 3. added_users, which is a dictionary to map from gitter user id to zulip id
+ 2. avatar_list, which is list to map avatars to Zulip avatars records.json
+ 3. added_users, which is a dictionary to map from Gitter user id to Zulip id
"""
logging.info('######### IMPORTING USERS STARTED #########\n')
zerver_userprofile = []
@@ -122,7 +122,7 @@ def build_stream_map(timestamp: Any,
Returns:
1. stream, which is the list of streams
2. defaultstreams, which is the list of default streams
- 3. stream_map, which is a dictionary to map from gitter rooms to zulip stream id
+ 3. stream_map, which is a dictionary to map from Gitter rooms to Zulip stream id
"""
logging.info('######### IMPORTING STREAM STARTED #########\n')
stream_id = 0
@@ -130,7 +130,7 @@ def build_stream_map(timestamp: Any,
# Default stream when no "room" field is present
stream.append(build_stream(timestamp, realm_id, 'from gitter',
- "Imported from gitter", stream_id))
+ "Imported from Gitter", stream_id))
defaultstream = build_defaultstream(realm_id=realm_id, stream_id=stream_id,
defaultstream_id=0)
stream_id += 1
@@ -218,7 +218,7 @@ def convert_gitter_workspace_messages(gitter_data: GitterDataT, output_dir: str,
mentioned_user_ids = get_usermentions(message, user_map,
user_short_name_to_full_name)
rendered_content = None
- topic_name = 'imported from gitter' + (f' room {message["room"]}' if 'room' in message else '')
+ topic_name = 'imported from Gitter' + (f' room {message["room"]}' if 'room' in message else '')
user_id = user_map[message['fromUser']['id']]
recipient_id = stream_map[message['room']] if 'room' in message else 0
zulip_message = build_message(topic_name, float(message_time), message_id, message['text'],
@@ -277,7 +277,7 @@ def do_convert_data(gitter_data_file: str, output_dir: str, threads: int=6) -> N
if os.listdir(output_dir):
raise Exception("Output directory should be empty!")
- # Read data from the gitter file
+ # Read data from the Gitter file
with open(gitter_data_file, "rb") as fp:
gitter_data = orjson.loads(fp.read())
diff --git a/zerver/data_import/hipchat.py b/zerver/data_import/hipchat.py
index 4f23007705..15e61f3993 100755
--- a/zerver/data_import/hipchat.py
+++ b/zerver/data_import/hipchat.py
@@ -107,12 +107,12 @@ def convert_user_data(user_handler: UserHandler,
if not email:
if role == UserProfile.ROLE_GUEST:
- # Hipchat guest users don't have emails, so
+ # HipChat guest users don't have emails, so
# we just fake them.
email = f'guest-{id}@example.com'
delivery_email = email
else:
- # Hipchat sometimes doesn't export an email for deactivated users.
+ # HipChat sometimes doesn't export an email for deactivated users.
assert not is_active
email = delivery_email = f"deactivated-{id}@example.com"
@@ -151,7 +151,7 @@ def convert_avatar_data(avatar_folder: str,
user_id_mapper: IdMapper,
realm_id: int) -> List[ZerverFieldsT]:
'''
- This code is pretty specific to how Hipchat sends us data.
+ This code is pretty specific to how HipChat sends us data.
They give us the avatar payloads in base64 in users.json.
We process avatars in our own pass of that data, rather
@@ -507,7 +507,7 @@ def get_hipchat_sender_id(realm_id: int,
if isinstance(message_dict['sender'], str):
if slim_mode:
return None
- # Some Hipchat instances just give us a person's
+ # Some HipChat instances just give us a person's
# name in the sender field for NotificationMessage.
# We turn them into a mirror user.
mirror_user = user_handler.get_mirror_user(
@@ -539,7 +539,7 @@ def get_hipchat_sender_id(realm_id: int,
sender_id = mirror_user['id']
return sender_id
- # HAPPY PATH: Hipchat just gave us an ordinary
+ # HAPPY PATH: HipChat just gave us an ordinary
# sender_id.
sender_id = user_id_mapper.get(raw_sender_id)
return sender_id
@@ -587,7 +587,7 @@ def process_message_file(realm_id: int,
# In Stride, user IDs are strings, but in HipChat,
# they are integers, and fn_id is always a string.
if str(sender_id) != str(fn_id):
- # PMs are in multiple places in the Hipchat export,
+ # PMs are in multiple places in the HipChat export,
# and we only use the copy from the sender
return None
@@ -702,7 +702,7 @@ def process_raw_message_batch(realm_id: int,
if is_pm_data:
topic_name = ''
else:
- topic_name = 'imported from hipchat'
+ topic_name = 'imported from HipChat'
user_id = raw_message['sender_id']
# Another side effect:
diff --git a/zerver/data_import/import_util.py b/zerver/data_import/import_util.py
index 760982d768..8b0a2ef8a0 100644
--- a/zerver/data_import/import_util.py
+++ b/zerver/data_import/import_util.py
@@ -103,7 +103,7 @@ def build_user_profile(avatar_source: str,
def build_avatar(zulip_user_id: int, realm_id: int, email: str, avatar_url: str,
timestamp: Any, avatar_list: List[ZerverFieldsT]) -> None:
avatar = dict(
- path=avatar_url, # Save original avatar url here, which is downloaded later
+ path=avatar_url, # Save original avatar URL here, which is downloaded later
realm_id=realm_id,
content_type=None,
user_profile_id=zulip_user_id,
@@ -170,9 +170,9 @@ def build_public_stream_subscriptions(
zerver_recipient: List[ZerverFieldsT],
zerver_stream: List[ZerverFieldsT]) -> List[ZerverFieldsT]:
'''
- This function is only used for Hipchat now, but it may apply to
+ This function is only used for HipChat now, but it may apply to
future conversions. We often don't get full subscriber data in
- the Hipchat export, so this function just autosubscribes all
+ the HipChat export, so this function just autosubscribes all
users to every public stream. This returns a list of Subscription
dicts.
'''
@@ -550,7 +550,7 @@ def write_avatar_png(avatar_folder: str,
user_id: int,
bits: bytes) -> ZerverFieldsT:
'''
- Use this function for conversions like Hipchat where
+ Use this function for conversions like HipChat where
the bits for the .png file come in something like
a users.json file, and where we don't have to
fetch avatar images externally.
diff --git a/zerver/data_import/mattermost.py b/zerver/data_import/mattermost.py
index 8be5e7e1b6..db7d123e76 100644
--- a/zerver/data_import/mattermost.py
+++ b/zerver/data_import/mattermost.py
@@ -249,12 +249,12 @@ def build_reactions(realm_id: int, total_reactions: List[ZerverFieldsT], reactio
for realm_emoji in zerver_realmemoji:
realmemoji[realm_emoji['name']] = realm_emoji['id']
- # For the unicode emoji codes, we use equivalent of
+ # For the Unicode emoji codes, we use equivalent of
# function 'emoji_name_to_emoji_code' in 'zerver/lib/emoji' here
for mattermost_reaction in reactions:
emoji_name = mattermost_reaction['emoji_name']
username = mattermost_reaction["user"]
- # Check in unicode emoji
+ # Check in Unicode emoji
if emoji_name in name_to_codepoint:
emoji_code = name_to_codepoint[emoji_name]
reaction_type = Reaction.UNICODE_EMOJI
diff --git a/zerver/data_import/slack.py b/zerver/data_import/slack.py
index 7780dbe244..d7ed8530c4 100755
--- a/zerver/data_import/slack.py
+++ b/zerver/data_import/slack.py
@@ -73,15 +73,15 @@ def slack_workspace_to_realm(domain_name: str, realm_id: int, user_list: List[Ze
ZerverFieldsT]:
"""
Returns:
- 1. realm, Converted Realm data
- 2. slack_user_id_to_zulip_user_id, which is a dictionary to map from slack user id to zulip user id
- 3. slack_recipient_name_to_zulip_recipient_id, which is a dictionary to map from slack recipient
- name(channel names, mpim names, usernames, etc) to zulip recipient id
- 4. added_channels, which is a dictionary to map from channel name to channel id, zulip stream_id
- 5. added_mpims, which is a dictionary to map from MPIM name to MPIM id, zulip huddle_id
+ 1. realm, converted realm data
+ 2. slack_user_id_to_zulip_user_id, which is a dictionary to map from Slack user id to Zulip user id
+ 3. slack_recipient_name_to_zulip_recipient_id, which is a dictionary to map from Slack recipient
+ name(channel names, mpim names, usernames, etc) to Zulip recipient id
+ 4. added_channels, which is a dictionary to map from channel name to channel id, Zulip stream_id
+ 5. added_mpims, which is a dictionary to map from MPIM name to MPIM id, Zulip huddle_id
6. dm_members, which is a dictionary to map from DM id to tuple of DM participants.
- 7. avatars, which is list to map avatars to zulip avatar records.json
- 8. emoji_url_map, which is maps emoji name to its slack url
+ 7. avatars, which is list to map avatars to Zulip avatar records.json
+ 8. emoji_url_map, which is maps emoji name to its Slack URL
"""
NOW = float(timezone_now().timestamp())
@@ -116,7 +116,7 @@ def build_realmemoji(custom_emoji_list: ZerverFieldsT,
emoji_id = 0
for emoji_name, url in custom_emoji_list.items():
if 'emoji.slack-edge.com' in url:
- # Some of the emojis we get from the api have invalid links
+ # Some of the emojis we get from the API have invalid links
# this is to prevent errors related to them
realmemoji = RealmEmoji(
name=emoji_name,
@@ -142,8 +142,8 @@ def users_to_zerver_userprofile(slack_data_dir: str, users: List[ZerverFieldsT],
"""
Returns:
1. zerver_userprofile, which is a list of user profile
- 2. avatar_list, which is list to map avatars to zulip avatard records.json
- 3. slack_user_id_to_zulip_user_id, which is a dictionary to map from slack user id to zulip
+ 2. avatar_list, which is list to map avatars to Zulip avatard records.json
+ 3. slack_user_id_to_zulip_user_id, which is a dictionary to map from Slack user ID to Zulip
user id
4. zerver_customprofilefield, which is a list of all custom profile fields
5. zerver_customprofilefield_values, which is a list of user profile fields
@@ -155,8 +155,8 @@ def users_to_zerver_userprofile(slack_data_dir: str, users: List[ZerverFieldsT],
avatar_list: List[ZerverFieldsT] = []
slack_user_id_to_zulip_user_id = {}
- # The user data we get from the slack api does not contain custom profile data
- # Hence we get it from the slack zip file
+ # The user data we get from the Slack API does not contain custom profile data
+ # Hence we get it from the Slack zip file
slack_data_file_user_list = get_data_file(slack_data_dir + '/users.json')
slack_user_id_to_custom_profile_fields: ZerverFieldsT = {}
@@ -165,7 +165,7 @@ def users_to_zerver_userprofile(slack_data_dir: str, users: List[ZerverFieldsT],
for user in slack_data_file_user_list:
process_slack_custom_fields(user, slack_user_id_to_custom_profile_fields)
- # We have only one primary owner in slack, see link
+ # We have only one primary owner in Slack, see link
# https://get.slack.help/hc/en-us/articles/201912948-Owners-and-Administrators
# This is to import the primary owner first from all the users
user_id_count = custom_profile_field_value_id_count = custom_profile_field_id_count = 0
@@ -239,7 +239,7 @@ def build_customprofile_field(customprofile_field: List[ZerverFieldsT], fields:
custom_profile_field_id: int, realm_id: int,
slack_custom_field_name_to_zulip_custom_field_id: ZerverFieldsT) \
-> Tuple[ZerverFieldsT, int]:
- # The name of the custom profile field is not provided in the slack data
+ # The name of the custom profile field is not provided in the Slack data
# Hash keys of the fields are provided
# Reference: https://api.slack.com/methods/users.profile.set
for field, value in fields.items():
@@ -248,7 +248,7 @@ def build_customprofile_field(customprofile_field: List[ZerverFieldsT], fields:
if field in slack_custom_fields:
field_name = field
else:
- field_name = f"slack custom field {str(custom_profile_field_id + 1)}"
+ field_name = f"Slack custom field {str(custom_profile_field_id + 1)}"
customprofilefield = CustomProfileField(
id=custom_profile_field_id,
name=field_name,
@@ -359,12 +359,12 @@ def channels_to_zerver_stream(slack_data_dir: str, realm_id: int,
DMMembersT, SlackToZulipRecipientT]:
"""
Returns:
- 1. realm, Converted Realm data
- 2. added_channels, which is a dictionary to map from channel name to channel id, zulip stream_id
- 3. added_mpims, which is a dictionary to map from MPIM(multiparty IM) name to MPIM id, zulip huddle_id
+ 1. realm, converted realm data
+ 2. added_channels, which is a dictionary to map from channel name to channel id, Zulip stream_id
+ 3. added_mpims, which is a dictionary to map from MPIM(multiparty IM) name to MPIM id, Zulip huddle_id
4. dm_members, which is a dictionary to map from DM id to tuple of DM participants.
- 5. slack_recipient_name_to_zulip_recipient_id, which is a dictionary to map from slack recipient
- name(channel names, mpim names, usernames etc) to zulip recipient_id
+ 5. slack_recipient_name_to_zulip_recipient_id, which is a dictionary to map from Slack recipient
+ name(channel names, mpim names, usernames etc) to Zulip recipient_id
"""
logging.info('######### IMPORTING CHANNELS STARTED #########\n')
@@ -709,7 +709,7 @@ def channel_message_to_zerver_message(realm_id: int,
slack_user_id = get_message_sending_user(message)
if not slack_user_id:
# Ignore messages without slack_user_id
- # These are Sometimes produced by slack
+ # These are Sometimes produced by Slack
continue
subtype = message.get('subtype', False)
@@ -787,7 +787,7 @@ def channel_message_to_zerver_message(realm_id: int,
has_attachment = file_info['has_attachment']
has_image = file_info['has_image']
- topic_name = 'imported from slack'
+ topic_name = 'imported from Slack'
zulip_message = build_message(topic_name, float(message['ts']), message_id, content,
rendered_content, slack_user_id_to_zulip_user_id[slack_user_id],
@@ -861,7 +861,7 @@ def process_message_files(message: ZerverFieldsT,
url = fileinfo['url_private']
if 'files.slack.com' in url:
- # For attachments with slack download link
+ # For attachments with Slack download link
has_attachment = True
has_link = True
has_image = True if 'image' in fileinfo['mimetype'] else False
@@ -878,7 +878,7 @@ def process_message_files(message: ZerverFieldsT,
build_attachment(realm_id, {message_id}, slack_user_id_to_zulip_user_id[slack_user_id],
fileinfo, s3_path, zerver_attachment)
else:
- # For attachments with link not from slack
+ # For attachments with link not from Slack
# Example: Google drive integration
has_link = True
if 'title' in fileinfo:
@@ -920,7 +920,7 @@ def build_reactions(reaction_list: List[ZerverFieldsT], reactions: List[ZerverFi
for realm_emoji in zerver_realmemoji:
realmemoji[realm_emoji['name']] = realm_emoji['id']
- # For the unicode emoji codes, we use equivalent of
+ # For the Unicode emoji codes, we use equivalent of
# function 'emoji_name_to_emoji_code' in 'zerver/lib/emoji' here
for slack_reaction in reactions:
emoji_name = slack_reaction['name']
@@ -951,7 +951,7 @@ def build_reactions(reaction_list: List[ZerverFieldsT], reactions: List[ZerverFi
def build_uploads(user_id: int, realm_id: int, email: str, fileinfo: ZerverFieldsT, s3_path: str,
uploads_list: List[ZerverFieldsT]) -> None:
upload = dict(
- path=fileinfo['url_private'], # Save slack's url here, which is used later while processing
+ path=fileinfo['url_private'], # Save Slack's URL here, which is used later while processing
realm_id=realm_id,
content_type=None,
user_profile_id=user_id,
@@ -1068,7 +1068,7 @@ def do_convert_data(slack_zip_file: str, output_dir: str, token: str, threads: i
subprocess.check_call(['unzip', '-q', slack_zip_file, '-d', slack_data_dir])
- # We get the user data from the legacy token method of slack api, which is depreciated
+ # We get the user data from the legacy token method of Slack API, which is depreciated
# but we use it as the user email data is provided only in this method
user_list = get_slack_api_data("https://slack.com/api/users.list", "members", token=token)
fetch_shared_channel_users(user_list, slack_data_dir, token)
diff --git a/zerver/data_import/slack_message_conversion.py b/zerver/data_import/slack_message_conversion.py
index 837bbbd64f..93bfd5b468 100644
--- a/zerver/data_import/slack_message_conversion.py
+++ b/zerver/data_import/slack_message_conversion.py
@@ -13,7 +13,7 @@ LINK_REGEX = r"""
([a-z0-9]+([\-\.]{1}[a-z0-9]+)*)(\.) # domain name
([a-z]{2,63}(:[0-9]{1,5})?) # domain
(\/[^>]*)? # path
- (\|)?(?:\|([^>]+))? # char after pipe (for slack links)
+ (\|)?(?:\|([^>]+))? # char after pipe (for Slack links)
(>)
"""
@@ -32,7 +32,7 @@ SLACK_USERMENTION_REGEX = r"""
(>) # ends with '>'
"""
# Slack doesn't have mid-word message-formatting like Zulip.
-# Hence, ~stri~ke doesn't format the word in slack, but ~~stri~~ke
+# Hence, ~stri~ke doesn't format the word in Slack, but ~~stri~~ke
# formats the word in Zulip
SLACK_STRIKETHROUGH_REGEX = r"""
(^|[ -(]|[+-/]|\*|\_|[:-?]|\{|\[|\||\^) # Start after specified characters
diff --git a/zerver/decorator.py b/zerver/decorator.py
index a650aae19d..3b55eaa4c5 100644
--- a/zerver/decorator.py
+++ b/zerver/decorator.py
@@ -66,7 +66,7 @@ def cachify(method: FuncT) -> FuncT:
def update_user_activity(request: HttpRequest, user_profile: UserProfile,
query: Optional[str]) -> None:
- # update_active_status also pushes to rabbitmq, and it seems
+ # update_active_status also pushes to RabbitMQ, and it seems
# redundant to log that here as well.
if request.META["PATH_INFO"] == '/json/users/me/presence':
return
@@ -350,7 +350,7 @@ def user_passes_test(test_func: Callable[[HttpResponse], bool], login_url: Optio
return view_func(request, *args, **kwargs)
path = request.build_absolute_uri()
resolved_login_url = resolve_url(login_url or settings.LOGIN_URL)
- # If the login url is the same scheme and net location then just
+ # If the login URL is the same scheme and net location then just
# use the path as the "next" url.
login_scheme, login_netloc = urllib.parse.urlparse(resolved_login_url)[:2]
current_scheme, current_netloc = urllib.parse.urlparse(path)[:2]
@@ -504,7 +504,7 @@ def authenticated_uploads_api_view(
return _wrapped_func_arguments
return _wrapped_view_func
-# A more REST-y authentication decorator, using, in particular, HTTP Basic
+# A more REST-y authentication decorator, using, in particular, HTTP basic
# authentication.
#
# If webhook_client_name is specific, the request is a webhook view
diff --git a/zerver/lib/avatar.py b/zerver/lib/avatar.py
index 80cfc41afb..94493eb99e 100644
--- a/zerver/lib/avatar.py
+++ b/zerver/lib/avatar.py
@@ -29,7 +29,7 @@ def avatar_url_from_dict(userdict: Dict[str, Any], medium: bool=False) -> str:
DEPRECATED: We should start using
get_avatar_field to populate users,
particularly for codepaths where the
- client can compute gravatar URLS
+ client can compute gravatar URLs
on the client side.
'''
url = _get_unversioned_avatar_url(
diff --git a/zerver/lib/cache.py b/zerver/lib/cache.py
index 56bfac40f5..894a0a8959 100644
--- a/zerver/lib/cache.py
+++ b/zerver/lib/cache.py
@@ -72,7 +72,7 @@ def get_or_create_key_prefix() -> str:
# This sets the prefix for the benefit of the Puppeteer tests.
#
# Having a fixed key is OK since we don't support running
- # multiple copies of the puppeteer tests at the same time anyway.
+ # multiple copies of the Puppeteer tests at the same time anyway.
return 'puppeteer_tests:'
elif settings.TEST_SUITE:
# The Python tests overwrite KEY_PREFIX on each test, but use
diff --git a/zerver/lib/camo.py b/zerver/lib/camo.py
index 5b57daa120..94e0ee1aad 100644
--- a/zerver/lib/camo.py
+++ b/zerver/lib/camo.py
@@ -15,7 +15,7 @@ def generate_camo_url(url: str) -> str:
# Encodes the provided URL using the same algorithm used by the camo
# caching https image proxy
def get_camo_url(url: str) -> str:
- # Only encode the url if Camo is enabled
+ # Only encode the URL if Camo is enabled
if settings.CAMO_URI == '':
return url
return f"{settings.CAMO_URI}{generate_camo_url(url)}"
diff --git a/zerver/lib/data_types.py b/zerver/lib/data_types.py
index a654dac72a..b0f2e8996d 100644
--- a/zerver/lib/data_types.py
+++ b/zerver/lib/data_types.py
@@ -63,7 +63,7 @@ class DictType:
raise AssertionError(f"Unknown key {k} in {var_name}")
def schema(self, var_name: str) -> str:
- # Our current schema is lossy, since our openapi configs
+ # Our current schema is lossy, since our OpenAPI configs
# aren't rigorous about "required" fields yet.
keys = sorted(list(self.required_keys) + list(self.optional_keys))
@@ -89,7 +89,7 @@ class Equals:
def __init__(self, expected_value: Any) -> None:
self.expected_value = expected_value
- # super hack for openapi workaround
+ # super hack for OpenAPI workaround
if self.expected_value is None:
self.equalsNone = True
@@ -99,7 +99,7 @@ class Equals:
def schema(self, var_name: str) -> str:
# Treat Equals as the degenerate case of EnumType, which
- # matches how we do things with openapi.
+ # matches how we do things with OpenAPI.
return f"{var_name} in {repr([self.expected_value])}"
@@ -164,7 +164,7 @@ class OptionalType:
check_data(self.sub_type, var_name, val)
def schema(self, var_name: str) -> str:
- # our openapi spec doesn't support optional types very well yet,
+ # our OpenAPI spec doesn't support optional types very well yet,
# so we just return the schema for our subtype
return schema(var_name, self.sub_type)
@@ -212,7 +212,7 @@ class UnionType:
raise AssertionError(f"{var_name} does not pass the union type check")
def schema(self, var_name: str) -> str:
- # We hack around our openapi specs not accounting for None.
+ # We hack around our OpenAPI specs not accounting for None.
sub_schemas = "\n".join(
sorted(
schema("type", sub_type)
@@ -231,7 +231,7 @@ class UrlType:
raise AssertionError(f"{var_name} is not a URL")
def schema(self, var_name: str) -> str:
- # just report str to match openapi
+ # just report str to match OpenAPI
return f"{var_name}: str"
@@ -278,7 +278,7 @@ def schema(
schema is a glorified repr of a data type, but it also includes a
var_name you pass in, plus we dumb things down a bit to match our
- current openapi spec.
+ current OpenAPI spec.
"""
if hasattr(data_type, "schema"):
return data_type.schema(var_name)
diff --git a/zerver/lib/email_notifications.py b/zerver/lib/email_notifications.py
index 3dad2c5fa6..acc29ba0f2 100644
--- a/zerver/lib/email_notifications.py
+++ b/zerver/lib/email_notifications.py
@@ -343,7 +343,7 @@ def do_send_missedmessage_events_reply_in_zulip(user_profile: UserProfile,
Send a reminder email to a user if she's missed some PMs by being offline.
The email will have its reply to address set to a limited used email
- address that will send a zulip message to the correct recipient. This
+ address that will send a Zulip message to the correct recipient. This
allows the user to respond to missed PMs, huddles, and @-mentions directly
from the email.
diff --git a/zerver/lib/external_accounts.py b/zerver/lib/external_accounts.py
index a7a55dbeab..88e44e5255 100644
--- a/zerver/lib/external_accounts.py
+++ b/zerver/lib/external_accounts.py
@@ -18,7 +18,7 @@ from zerver.lib.validator import (
# text: Field text for admins - custom profile field in org settngs view
# name: Field label or name - user profile in user settings view
# hint: Field hint for realm users
-# url_patter: Field url linkifier
+# url_pattern: Field URL linkifier
DEFAULT_EXTERNAL_ACCOUNTS = {
"twitter": {
"text": "Twitter",
@@ -45,7 +45,7 @@ def validate_external_account_field_data(field_data: ProfileFieldData) -> Profil
if field_subtype not in DEFAULT_EXTERNAL_ACCOUNTS.keys():
if field_subtype == "custom":
if 'url_pattern' not in field_data.keys():
- raise ValidationError(_("Custom external account must define url pattern"))
+ raise ValidationError(_("Custom external account must define URL pattern"))
else:
raise ValidationError(_("Invalid external account type"))
diff --git a/zerver/lib/import_realm.py b/zerver/lib/import_realm.py
index 0287d73af6..61bb0290de 100644
--- a/zerver/lib/import_realm.py
+++ b/zerver/lib/import_realm.py
@@ -355,8 +355,8 @@ def idseq(model_class: Any) -> str:
def allocate_ids(model_class: Any, count: int) -> List[int]:
"""
Increases the sequence number for a given table by the amount of objects being
- imported into that table. Hence, this gives a reserved range of ids to import the
- converted slack objects into the tables.
+ imported into that table. Hence, this gives a reserved range of IDs to import the
+ converted Slack objects into the tables.
"""
conn = connection.cursor()
sequence = idseq(model_class)
@@ -1030,7 +1030,7 @@ def do_import_realm(import_dir: Path, subdomain: str, processes: int=1) -> Realm
import_uploads(realm, os.path.join(import_dir, "uploads"), processes)
# We need to have this check as the emoji files are only present in the data
- # importer from slack
+ # importer from Slack
# For Zulip export, this doesn't exist
if os.path.exists(os.path.join(import_dir, "emoji")):
import_uploads(realm, os.path.join(import_dir, "emoji"), processes, processing_emojis=True)
@@ -1198,7 +1198,7 @@ def import_message_data(realm: Realm,
re_map_foreign_keys(data, 'zerver_message', 'recipient', related_table="recipient")
re_map_foreign_keys(data, 'zerver_message', 'sending_client', related_table='client')
fix_datetime_fields(data, 'zerver_message')
- # Parser to update message content with the updated attachment urls
+ # Parser to update message content with the updated attachment URLs
fix_upload_links(data, 'zerver_message')
# We already create mappings for zerver_message ids
diff --git a/zerver/lib/integrations.py b/zerver/lib/integrations.py
index 2900ff57ce..d057802e9f 100644
--- a/zerver/lib/integrations.py
+++ b/zerver/lib/integrations.py
@@ -271,7 +271,7 @@ WEBHOOK_INTEGRATIONS: List[WebhookIntegration] = [
WebhookIntegration(
'alertmanager',
['monitoring'],
- display_name='Prometheus AlertManager',
+ display_name='Prometheus Alertmanager',
logo='images/integrations/logos/prometheus.svg',
),
WebhookIntegration('ansibletower', ['deployment'], display_name='Ansible Tower'),
diff --git a/zerver/lib/markdown/__init__.py b/zerver/lib/markdown/__init__.py
index 6b8d010cd0..4b2436b3cf 100644
--- a/zerver/lib/markdown/__init__.py
+++ b/zerver/lib/markdown/__init__.py
@@ -162,7 +162,7 @@ def get_web_link_regex() -> str:
# A link starts at a word boundary, and ends at space, punctuation, or end-of-input.
#
- # We detect a url either by the `https?://` or by building around the TLD.
+ # We detect a URL either by the `https?://` or by building around the TLD.
# In lieu of having a recursive regex (which python doesn't support) to match
# arbitrary numbers of nested matching parenthesis, we manually build a regexp that
@@ -668,7 +668,7 @@ class InlineInterestingLinkProcessor(markdown.treeprocessors.Treeprocessor):
description_elm.text = description
def get_actual_image_url(self, url: str) -> str:
- # Add specific per-site cases to convert image-preview urls to image urls.
+ # Add specific per-site cases to convert image-preview URLs to image URLs.
# See https://github.com/zulip/zulip/issues/4658 for more information
parsed_url = urllib.parse.urlparse(url)
if (parsed_url.netloc == 'github.com' or parsed_url.netloc.endswith('.github.com')):
@@ -685,7 +685,7 @@ class InlineInterestingLinkProcessor(markdown.treeprocessors.Treeprocessor):
if not self.md.image_preview_enabled:
return False
parsed_url = urllib.parse.urlparse(url)
- # remove html urls which end with img extensions that can not be shorted
+ # remove HTML URLs which end with image extensions that can not be shorted
if parsed_url.netloc == 'pasteboard.co':
return False
@@ -696,15 +696,15 @@ class InlineInterestingLinkProcessor(markdown.treeprocessors.Treeprocessor):
return False
def corrected_image_source(self, url: str) -> Optional[str]:
- # This function adjusts any urls from linx.li and
- # wikipedia.org to point to the actual image url. It's
+ # This function adjusts any URLs from linx.li and
+ # wikipedia.org to point to the actual image URL. It's
# structurally very similar to dropbox_image, and possibly
# should be rewritten to use open graph, but has some value.
parsed_url = urllib.parse.urlparse(url)
if parsed_url.netloc.lower().endswith('.wikipedia.org'):
# Redirecting from "/wiki/File:" to "/wiki/Special:FilePath/File:"
# A possible alternative, that avoids the redirect after hitting "Special:"
- # is using the first characters of md5($filename) to generate the url
+ # is using the first characters of md5($filename) to generate the URL
domain = parsed_url.scheme + "://" + parsed_url.netloc
correct_url = domain + parsed_url.path[:6] + 'Special:FilePath' + parsed_url.path[5:]
return correct_url
@@ -760,7 +760,7 @@ class InlineInterestingLinkProcessor(markdown.treeprocessors.Treeprocessor):
def youtube_id(self, url: str) -> Optional[str]:
if not self.md.image_preview_enabled:
return None
- # Youtube video id extraction regular expression from https://pastebin.com/KyKAFv1s
+ # YouTube video id extraction regular expression from https://pastebin.com/KyKAFv1s
# Slightly modified to support URLs of the forms
# - youtu.be/
# - youtube.com/playlist?v=&list=
@@ -817,11 +817,11 @@ class InlineInterestingLinkProcessor(markdown.treeprocessors.Treeprocessor):
user_mentions: List[Dict[str, Any]],
media: List[Dict[str, Any]]) -> Element:
"""
- Use data from the twitter API to turn links, mentions and media into A
- tags. Also convert unicode emojis to images.
+ Use data from the Twitter API to turn links, mentions and media into A
+ tags. Also convert Unicode emojis to images.
- This works by using the urls, user_mentions and media data from
- the twitter API and searching for unicode emojis in the text using
+ This works by using the URLs, user_mentions and media data from
+ the twitter API and searching for Unicode emojis in the text using
`unicode_emoji_regex`.
The first step is finding the locations of the URLs, mentions, media and
@@ -1167,7 +1167,7 @@ class InlineInterestingLinkProcessor(markdown.treeprocessors.Treeprocessor):
if not self.is_absolute_url(url):
if self.is_image(url):
self.handle_image_inlining(root, found_url)
- # We don't have a strong use case for doing url preview for relative links.
+ # We don't have a strong use case for doing URL preview for relative links.
continue
dropbox_image = self.dropbox_image(url)
@@ -1276,7 +1276,7 @@ class Timestamp(markdown.inlinepatterns.Pattern):
time_element.text = markdown.util.AtomicString(time_input_string)
return time_element
-# All of our emojis(non ZWJ sequences) belong to one of these unicode blocks:
+# All of our emojis(non ZWJ sequences) belong to one of these Unicode blocks:
# \U0001f100-\U0001f1ff - Enclosed Alphanumeric Supplement
# \U0001f200-\U0001f2ff - Enclosed Ideographic Supplement
# \U0001f300-\U0001f5ff - Miscellaneous Symbols and Pictographs
@@ -1311,13 +1311,13 @@ unicode_emoji_regex = '(?P['\
# The equivalent JS regex is \ud83c[\udd00-\udfff]|\ud83d[\udc00-\ude4f]|\ud83d[\ude80-\udeff]|
# \ud83e[\udd00-\uddff]|[\u2000-\u206f]|[\u2300-\u27bf]|[\u2b00-\u2bff]|[\u3000-\u303f]|
# [\u3200-\u32ff]. See below comments for explanation. The JS regex is used by marked.js for
-# frontend unicode emoji processing.
+# frontend Unicode emoji processing.
# The JS regex \ud83c[\udd00-\udfff]|\ud83d[\udc00-\ude4f] represents U0001f100-\U0001f64f
# The JS regex \ud83d[\ude80-\udeff] represents \U0001f680-\U0001f6ff
# The JS regex \ud83e[\udd00-\uddff] represents \U0001f900-\U0001f9ff
# The JS regex [\u2000-\u206f] represents \u2000-\u206f
# The JS regex [\u2300-\u27bf] represents \u2300-\u27bf
-# Similarly other JS regexes can be mapped to the respective unicode blocks.
+# Similarly other JS regexes can be mapped to the respective Unicode blocks.
# For more information, please refer to the following article:
# http://crocodillon.com/blog/parsing-emoji-unicode-in-javascript
@@ -1418,14 +1418,14 @@ class Tex(markdown.inlinepatterns.Pattern):
def sanitize_url(url: str) -> Optional[str]:
"""
- Sanitize a url against xss attacks.
+ Sanitize a URL against XSS attacks.
See the docstring on markdown.inlinepatterns.LinkPattern.sanitize_url.
"""
try:
parts = urllib.parse.urlparse(url.replace(' ', '%20'))
scheme, netloc, path, params, query, fragment = parts
except ValueError:
- # Bad url - so bad it couldn't be parsed.
+ # Bad URL - so bad it couldn't be parsed.
return ''
# If there is no scheme or netloc and there is a '@' in the path,
@@ -1467,7 +1467,7 @@ def sanitize_url(url: str) -> Optional[str]:
# We already converted an empty scheme to http:// above, so we skip
# the colon check, which would also forbid a lot of legitimate URLs.
- # Url passes all tests. Return url as-is.
+ # URL passes all tests. Return URL as-is.
return urllib.parse.urlunparse((scheme, netloc, path, params, query, fragment))
def url_to_a(db_data: Optional[DbData], url: str, text: Optional[str]=None) -> Union[Element, str]:
@@ -1530,7 +1530,7 @@ class ListIndentProcessor(markdown.blockprocessors.ListIndentProcessor):
parser.md.tab_length = 4
class HashHeaderProcessor(markdown.blockprocessors.HashHeaderProcessor):
- """ Process Hash Headers.
+ """ Process hash headers.
Based on markdown.blockprocessors.HashHeaderProcessor, but requires space for heading.
"""
@@ -1540,7 +1540,7 @@ class HashHeaderProcessor(markdown.blockprocessors.HashHeaderProcessor):
RE = re.compile(r'(?:^|\n)(?P#{1,6})\s(?P(?:\\.|[^\\])*?)#*(?:\n|$)')
class BlockQuoteProcessor(markdown.blockprocessors.BlockQuoteProcessor):
- """ Process BlockQuotes.
+ """ Process block quotes.
Based on markdown.blockprocessors.BlockQuoteProcessor, but with 2-space indent
"""
@@ -1812,7 +1812,7 @@ class LinkInlineProcessor(markdown.inlinepatterns.LinkInlineProcessor):
href = el.get('href')
assert href is not None
- # Sanitize url or don't parse link. See linkify_tests in markdown_test_cases for banned syntax.
+ # Sanitize URL or don't parse link. See linkify_tests in markdown_test_cases for banned syntax.
href = sanitize_url(self.unescape(href.strip()))
if href is None:
return None # no-op; the link is not processed.
@@ -1841,7 +1841,7 @@ class LinkInlineProcessor(markdown.inlinepatterns.LinkInlineProcessor):
return el, match_start, index
def get_sub_registry(r: markdown.util.Registry, keys: List[str]) -> markdown.util.Registry:
- # Registry is a new class added by py-markdown to replace Ordered List.
+ # Registry is a new class added by Python-Markdown to replace OrderedDict.
# Since Registry doesn't support .keys(), it is easier to make a new
# object instead of removing keys from the existing object.
new_r = markdown.util.Registry()
@@ -1869,11 +1869,11 @@ class Markdown(markdown.Markdown):
self.set_output_format('html')
def build_parser(self) -> markdown.Markdown:
- # Build the parser using selected default features from py-markdown.
+ # Build the parser using selected default features from Python-Markdown.
# The complete list of all available processors can be found in the
# super().build_parser() function.
#
- # Note: for any py-markdown updates, manually check if we want any
+ # Note: for any Python-Markdown updates, manually check if we want any
# of the new features added upstream or not; they wouldn't get
# included by default.
self.preprocessors = self.build_preprocessors()
@@ -1948,7 +1948,7 @@ class Markdown(markdown.Markdown):
ENTITY_RE = markdown.inlinepatterns.ENTITY_RE
STRONG_EM_RE = r'(\*\*\*)(?!\s+)([^\*^\n]+)(? List[str]:
for m in re.finditer(pattern, topic_name):
matches += [realm_filter[1] % m.groupdict()]
- # Also make raw urls navigable.
+ # Also make raw URLs navigable.
for sub_string in basic_link_splitter.split(topic_name):
link_match = re.match(get_web_link_regex(), sub_string)
if link_match:
diff --git a/zerver/lib/markdown/tabbed_sections.py b/zerver/lib/markdown/tabbed_sections.py
index f337d093f5..6eb918aea9 100644
--- a/zerver/lib/markdown/tabbed_sections.py
+++ b/zerver/lib/markdown/tabbed_sections.py
@@ -58,7 +58,7 @@ TAB_DISPLAY_NAMES = {
'mm-default': 'Default installation',
'mm-docker': 'Docker',
- 'mm-gitlab-omnibus': 'Gitlab Omnibus',
+ 'mm-gitlab-omnibus': 'GitLab Omnibus',
'send-email-invitations': 'Send email invitations',
'share-an-invite-link': 'Share an invite link',
diff --git a/zerver/lib/migrate.py b/zerver/lib/migrate.py
index 8fb5399261..95b9723209 100644
--- a/zerver/lib/migrate.py
+++ b/zerver/lib/migrate.py
@@ -13,7 +13,7 @@ def do_batch_update(cursor: CursorObj,
batch_size: int=10000,
sleep: float=0.1) -> None: # nocoverage
# The string substitution below is complicated by our need to
- # support multiple postgres versions.
+ # support multiple Postgres versions.
stmt = SQL('''
UPDATE {}
SET {}
diff --git a/zerver/lib/name_restrictions.py b/zerver/lib/name_restrictions.py
index 151cfb44f1..53b8c67da9 100644
--- a/zerver/lib/name_restrictions.py
+++ b/zerver/lib/name_restrictions.py
@@ -18,7 +18,7 @@ def is_disposable_domain(domain: str) -> bool:
return domain.lower() in DISPOSABLE_DOMAINS
ZULIP_RESERVED_SUBDOMAINS = {
- # zulip terms
+ # Zulip terms
'stream', 'channel', 'topic', 'thread', 'installation', 'organization', 'realm',
'team', 'subdomain', 'activity', 'octopus', 'acme', 'push',
# machines
@@ -29,7 +29,7 @@ ZULIP_RESERVED_SUBDOMAINS = {
# competitor pages
'slack', 'mattermost', 'rocketchat', 'irc', 'twitter', 'zephyr', 'flowdock', 'spark',
'skype', 'microsoft', 'twist', 'ryver', 'matrix', 'discord', 'email', 'usenet',
- # zulip names
+ # Zulip names
'zulip', 'tulip', 'humbug',
# platforms
'plan9', 'electron', 'linux', 'mac', 'windows', 'cli', 'ubuntu', 'android', 'ios',
diff --git a/zerver/lib/push_notifications.py b/zerver/lib/push_notifications.py
index ef71a32517..1c2faa4b61 100644
--- a/zerver/lib/push_notifications.py
+++ b/zerver/lib/push_notifications.py
@@ -504,7 +504,7 @@ def get_gcm_alert(message: Message) -> str:
def get_mobile_push_content(rendered_content: str) -> str:
def get_text(elem: lxml.html.HtmlElement) -> str:
- # Convert default emojis to their unicode equivalent.
+ # Convert default emojis to their Unicode equivalent.
classes = elem.get("class", "")
if "emoji" in classes:
match = re.search(r"emoji-(?P\S+)", classes)
@@ -571,9 +571,9 @@ def get_mobile_push_content(rendered_content: str) -> str:
return plain_text
def truncate_content(content: str) -> Tuple[str, bool]:
- # We use unicode character 'HORIZONTAL ELLIPSIS' (U+2026) instead
+ # We use Unicode character 'HORIZONTAL ELLIPSIS' (U+2026) instead
# of three dots as this saves two extra characters for textual
- # content. This function will need to be updated to handle unicode
+ # content. This function will need to be updated to handle Unicode
# combining characters and tags when we start supporting themself.
if len(content) <= 200:
return content, False
diff --git a/zerver/lib/rate_limiter.py b/zerver/lib/rate_limiter.py
index 78826dc48d..ad2d5c754c 100644
--- a/zerver/lib/rate_limiter.py
+++ b/zerver/lib/rate_limiter.py
@@ -394,7 +394,7 @@ class RedisRateLimiterBackend(RateLimiterBackend):
list_key, set_key, _ = cls.get_keys(entity_key)
now = time.time()
- # Start redis transaction
+ # Start Redis transaction
with client.pipeline() as pipe:
count = 0
while True:
diff --git a/zerver/lib/redis_utils.py b/zerver/lib/redis_utils.py
index ab0233a01e..e1d37bb836 100644
--- a/zerver/lib/redis_utils.py
+++ b/zerver/lib/redis_utils.py
@@ -47,7 +47,7 @@ def get_dict_from_redis(redis_client: redis.StrictRedis, key_format: str, key: s
# This function requires inputting the intended key_format to validate
# that the key fits it, as an additionally security measure. This protects
# against bugs where a caller requests a key based on user input and doesn't
- # validate it - which could potentially allow users to poke around arbitrary redis keys.
+ # validate it - which could potentially allow users to poke around arbitrary Redis keys.
if len(key) > MAX_KEY_LENGTH:
error_msg = "Requested key too long in get_dict_from_redis: %s"
raise ZulipRedisKeyTooLongError(error_msg % (key,))
diff --git a/zerver/lib/rest.py b/zerver/lib/rest.py
index 8487bfbc28..6a29088b6d 100644
--- a/zerver/lib/rest.py
+++ b/zerver/lib/rest.py
@@ -43,7 +43,7 @@ def rest_dispatch(request: HttpRequest, **kwargs: Any) -> HttpResponse:
Unauthenticated endpoints should not use this, as authentication is verified
in the following ways:
- * for paths beginning with /api, HTTP Basic auth
+ * for paths beginning with /api, HTTP basic auth
* for paths beginning with /json (used by the web client), the session token
This calls the function named in kwargs[request.method], if that request
@@ -108,7 +108,7 @@ def rest_dispatch(request: HttpRequest, **kwargs: Any) -> HttpResponse:
# as we should worst-case fail closed if we miscategorise a request.
# for some special views (e.g. serving a file that has been
- # uploaded), we support using the same url for web and API clients.
+ # uploaded), we support using the same URL for web and API clients.
if ('override_api_url_scheme' in view_flags and
request.META.get('HTTP_AUTHORIZATION', None) is not None):
# This request uses standard API based authentication.
@@ -132,7 +132,7 @@ def rest_dispatch(request: HttpRequest, **kwargs: Any) -> HttpResponse:
auth_kwargs["skip_rate_limiting"] = True
target_function = csrf_protect(authenticated_json_view(target_function, **auth_kwargs))
- # most clients (mobile, bots, etc) use HTTP Basic Auth and REST calls, where instead of
+ # most clients (mobile, bots, etc) use HTTP basic auth and REST calls, where instead of
# username:password, we use email:apiKey
elif request.META.get('HTTP_AUTHORIZATION', None):
# Wrap function with decorator to authenticate the user before
diff --git a/zerver/lib/soft_deactivation.py b/zerver/lib/soft_deactivation.py
index ee6e955f28..c67a9a01db 100644
--- a/zerver/lib/soft_deactivation.py
+++ b/zerver/lib/soft_deactivation.py
@@ -82,7 +82,7 @@ def filter_by_subscription_history(user_profile: UserProfile,
if stream_messages[-1]['id'] <= log_entry.event_last_message_id:
stream_messages = []
else:
- raise AssertionError(f'{log_entry.event_type} is not a Subscription Event.')
+ raise AssertionError(f'{log_entry.event_type} is not a subscription event.')
if len(stream_messages) > 0:
# We do this check for last event since if the last subscription
@@ -218,7 +218,7 @@ def do_soft_deactivate_user(user_profile: UserProfile) -> None:
user_profile.save(update_fields=[
'long_term_idle',
'last_active_message_id'])
- logger.info('Soft Deactivated user %s', user_profile.id)
+ logger.info('Soft deactivated user %s', user_profile.id)
def do_soft_deactivate_users(users: List[UserProfile]) -> List[UserProfile]:
BATCH_SIZE = 100
diff --git a/zerver/lib/test_classes.py b/zerver/lib/test_classes.py
index ec0fc9ff2d..1fb9eb0c1b 100644
--- a/zerver/lib/test_classes.py
+++ b/zerver/lib/test_classes.py
@@ -82,7 +82,7 @@ if settings.ZILENCER_ENABLED:
class UploadSerializeMixin(SerializeMixin):
"""
We cannot use override_settings to change upload directory because
- because settings.LOCAL_UPLOADS_DIR is used in url pattern and urls
+ because settings.LOCAL_UPLOADS_DIR is used in URL pattern and URLs
are compiled only once. Otherwise using a different upload directory
for conflicting test cases would have provided better performance
while providing the required isolation.
@@ -117,7 +117,7 @@ class ZulipTestCase(TestCase):
flush_per_request_caches()
translation.activate(settings.LANGUAGE_CODE)
- # Clean up after using fakeldap in ldap tests:
+ # Clean up after using fakeldap in LDAP tests:
if hasattr(self, 'mock_ldap') and hasattr(self, 'mock_initialize'):
if self.mock_ldap is not None:
self.mock_ldap.reset()
@@ -192,8 +192,8 @@ Output:
def extract_api_suffix_url(self, url: str) -> Tuple[str, Dict[str, Any]]:
"""
- Function that extracts the url after `/api/v1` or `/json` and also
- returns the query data in the url, if there is any.
+ Function that extracts the URL after `/api/v1` or `/json` and also
+ returns the query data in the URL, if there is any.
"""
url_split = url.split('?')
data: Dict[str, Any] = {}
@@ -229,7 +229,7 @@ Output:
json_url = True
url, query_data = self.extract_api_suffix_url(url)
if len(query_data) != 0:
- # In some cases the query parameters are defined in the url itself. In such cases
+ # In some cases the query parameters are defined in the URL itself. In such cases
# The `data` argument of our function is not used. Hence get `data` argument
# from url.
data = query_data
@@ -1016,13 +1016,13 @@ Output:
for dn, attrs in directory.items():
if 'uid' in attrs:
- # Generate a password for the ldap account:
+ # Generate a password for the LDAP account:
attrs['userPassword'] = [self.ldap_password(attrs['uid'][0])]
# Load binary attributes. If in "directory", an attribute as its value
# has a string starting with "file:", the rest of the string is assumed
# to be a path to the file from which binary data should be loaded,
- # as the actual value of the attribute in ldap.
+ # as the actual value of the attribute in LDAP.
for attr, value in attrs.items():
if isinstance(value, str) and value.startswith("file:"):
with open(value[5:], 'rb') as f:
@@ -1054,9 +1054,9 @@ Output:
def ldap_username(self, username: str) -> str:
"""
- Maps zulip username to the name of the corresponding ldap user
+ Maps Zulip username to the name of the corresponding LDAP user
in our test directory at zerver/tests/fixtures/ldap/directory.json,
- if the ldap user exists.
+ if the LDAP user exists.
"""
return self.example_user_ldap_username_map[username]
@@ -1068,7 +1068,7 @@ class WebhookTestCase(ZulipTestCase):
Common for all webhooks tests
Override below class attributes and run send_and_test_message
- If you create your url in uncommon way you can override build_webhook_url method
+ If you create your URL in uncommon way you can override build_webhook_url method
In case that you need modify body or create it without using fixture you can also override get_body method
"""
STREAM_NAME: Optional[str] = None
diff --git a/zerver/lib/test_runner.py b/zerver/lib/test_runner.py
index f584c2947b..cf1d26bf90 100644
--- a/zerver/lib/test_runner.py
+++ b/zerver/lib/test_runner.py
@@ -205,7 +205,7 @@ def init_worker(counter: Synchronized) -> None:
create_test_databases(_worker_id)
initialize_worker_path(_worker_id)
- # We manually update the upload directory path in the url regex.
+ # We manually update the upload directory path in the URL regex.
from zproject.dev_urls import avatars_url
new_root = os.path.join(settings.LOCAL_UPLOADS_DIR, "avatars")
avatars_url.default_args['document_root'] = new_root
diff --git a/zerver/lib/thumbnail.py b/zerver/lib/thumbnail.py
index 115589a208..db3c112db5 100644
--- a/zerver/lib/thumbnail.py
+++ b/zerver/lib/thumbnail.py
@@ -69,7 +69,7 @@ def generate_thumbnail_url(path: str,
if settings.THUMBOR_URL == 'http://127.0.0.1:9995':
# If THUMBOR_URL is the default then thumbor is hosted on same machine
# as the Zulip server and we should serve a relative URL.
- # We add a /thumbor in front of the relative url because we make
+ # We add a /thumbor in front of the relative URL because we make
# use of a proxy pass to redirect request internally in Nginx to 9995
# port where thumbor is running.
thumbnail_url = '/thumbor' + encrypted_url
diff --git a/zerver/lib/topic.py b/zerver/lib/topic.py
index 51bc59cc89..b8a0fc2bad 100644
--- a/zerver/lib/topic.py
+++ b/zerver/lib/topic.py
@@ -66,7 +66,7 @@ DB_TOPIC_NAME = "subject"
MESSAGE__TOPIC = 'message__subject'
def topic_match_sa(topic_name: str) -> Any:
- # _sa is short for Sql Alchemy, which we use mostly for
+ # _sa is short for SQLAlchemy, which we use mostly for
# queries that search messages
topic_cond = func.upper(column("subject")) == func.upper(literal(topic_name))
return topic_cond
diff --git a/zerver/lib/upload.py b/zerver/lib/upload.py
index eeb4ba383f..e075a1259e 100644
--- a/zerver/lib/upload.py
+++ b/zerver/lib/upload.py
@@ -59,7 +59,7 @@ INLINE_MIME_TYPES = [
# image/svg+xml, text/html, or text/xml.
]
-# Performance Note:
+# Performance note:
#
# For writing files to S3, the file could either be stored in RAM
# (if it is less than 2.5MiB or so) or an actual temporary file on disk.
@@ -80,7 +80,7 @@ class RealmUploadQuotaError(JsonableError):
def sanitize_name(value: str) -> str:
"""
Sanitizes a value to be safe to store in a Linux filesystem, in
- S3, and in a URL. So unicode is allowed, but not special
+ S3, and in a URL. So Unicode is allowed, but not special
characters other than ".", "-", and "_".
This implementation is based on django.utils.text.slugify; it is
diff --git a/zerver/logging_handlers.py b/zerver/logging_handlers.py
index c8b4c5263a..273a568e6d 100644
--- a/zerver/logging_handlers.py
+++ b/zerver/logging_handlers.py
@@ -105,7 +105,7 @@ class AdminNotifyHandler(logging.Handler):
# recursive exception loops are made).
#
# We initialize is_markdown_rendering_exception to `True` to
- # prevent the infinite loop of zulip messages by ERROR_BOT if
+ # prevent the infinite loop of Zulip messages by ERROR_BOT if
# the outer try block here throws an exception before we have
# a chance to check the exception for whether it comes from
# markdown.
diff --git a/zerver/management/commands/check_redis.py b/zerver/management/commands/check_redis.py
index dc9f4e0838..39e626c606 100644
--- a/zerver/management/commands/check_redis.py
+++ b/zerver/management/commands/check_redis.py
@@ -10,8 +10,8 @@ from zerver.models import get_user_profile_by_id
class Command(BaseCommand):
- help = """Checks redis to make sure our rate limiting system hasn't grown a bug
- and left redis with a bunch of data
+ help = """Checks Redis to make sure our rate limiting system hasn't grown a bug
+ and left Redis with a bunch of data
Usage: ./manage.py [--trim] check_redis"""
@@ -41,7 +41,7 @@ than max_api_calls! (trying to trim) %s %s", key, count)
def handle(self, *args: Any, **options: Any) -> None:
if not settings.RATE_LIMITING:
- raise CommandError("This machine is not using redis or rate limiting, aborting")
+ raise CommandError("This machine is not using Redis or rate limiting, aborting")
# Find all keys, and make sure they're all within size constraints
wildcard_list = "ratelimit:*:*:list"
diff --git a/zerver/management/commands/convert_gitter_data.py b/zerver/management/commands/convert_gitter_data.py
index cc5da9fc40..f55e8dd200 100644
--- a/zerver/management/commands/convert_gitter_data.py
+++ b/zerver/management/commands/convert_gitter_data.py
@@ -41,5 +41,5 @@ class Command(BaseCommand):
if not os.path.exists(path):
raise CommandError(f"Gitter data file not found: '{path}'")
# TODO add json check
- print("Converting Data ...")
+ print("Converting data ...")
do_convert_data(path, output_dir, num_threads)
diff --git a/zerver/management/commands/convert_hipchat_data.py b/zerver/management/commands/convert_hipchat_data.py
index 615f1f6626..ce2154ae9e 100644
--- a/zerver/management/commands/convert_hipchat_data.py
+++ b/zerver/management/commands/convert_hipchat_data.py
@@ -27,12 +27,12 @@ from zerver.data_import.hipchat import do_convert_data
class Command(BaseCommand):
- help = """Convert the Hipchat data into Zulip data format."""
+ help = """Convert the HipChat data into Zulip data format."""
def add_arguments(self, parser: CommandParser) -> None:
parser.add_argument('hipchat_tar', nargs='+',
metavar='',
- help="tar of Hipchat data")
+ help="tar of HipChat data")
parser.add_argument('--output', dest='output_dir',
help='Directory to write exported data to.')
@@ -71,7 +71,7 @@ class Command(BaseCommand):
if not os.path.exists(path):
raise CommandError(f"Tar file not found: '{path}'")
- print("Converting Data ...")
+ print("Converting data ...")
do_convert_data(
input_tar_file=path,
output_dir=output_dir,
diff --git a/zerver/management/commands/convert_mattermost_data.py b/zerver/management/commands/convert_mattermost_data.py
index 887c3bef02..65a31226dc 100644
--- a/zerver/management/commands/convert_mattermost_data.py
+++ b/zerver/management/commands/convert_mattermost_data.py
@@ -56,7 +56,7 @@ class Command(BaseCommand):
raise CommandError(f"Directory not found: '{data_dir}'")
data_dir = os.path.realpath(data_dir)
- print("Converting Data ...")
+ print("Converting data ...")
do_convert_data(
mattermost_data_dir=data_dir,
output_dir=output_dir,
diff --git a/zerver/management/commands/convert_slack_data.py b/zerver/management/commands/convert_slack_data.py
index d0ac853daf..d429a1da6b 100644
--- a/zerver/management/commands/convert_slack_data.py
+++ b/zerver/management/commands/convert_slack_data.py
@@ -14,8 +14,8 @@ class Command(BaseCommand):
def add_arguments(self, parser: CommandParser) -> None:
parser.add_argument('slack_data_zip', nargs='+',
- metavar='',
- help="Zipped slack data")
+ metavar='',
+ help="Zipped Slack data")
parser.add_argument('--token', metavar='',
help='Slack legacy token of the organsation')
@@ -38,7 +38,7 @@ class Command(BaseCommand):
token = options['token']
if token is None:
- raise CommandError("Enter slack legacy token!")
+ raise CommandError("Enter Slack legacy token!")
num_threads = int(options['threads'])
if num_threads < 1:
@@ -48,5 +48,5 @@ class Command(BaseCommand):
if not os.path.exists(path):
raise CommandError(f"Slack data directory not found: '{path}'")
- print("Converting Data ...")
+ print("Converting data ...")
do_convert_data(path, output_dir, token, threads=num_threads)
diff --git a/zerver/management/commands/create_large_indexes.py b/zerver/management/commands/create_large_indexes.py
index a77dd24419..c49160d426 100644
--- a/zerver/management/commands/create_large_indexes.py
+++ b/zerver/management/commands/create_large_indexes.py
@@ -7,7 +7,7 @@ from zerver.lib.management import ZulipBaseCommand
def create_indexes() -> None:
# Creating concurrent indexes is kind of a pain with current versions
- # of Django/postgres, because you will get this error with seemingly
+ # of Django/Postgres, because you will get this error with seemingly
# reasonable code:
#
# CREATE INDEX CONCURRENTLY cannot be executed from a function or multi-command string
diff --git a/zerver/management/commands/delete_old_unclaimed_attachments.py b/zerver/management/commands/delete_old_unclaimed_attachments.py
index 1e6ccf74f0..f73380a44a 100644
--- a/zerver/management/commands/delete_old_unclaimed_attachments.py
+++ b/zerver/management/commands/delete_old_unclaimed_attachments.py
@@ -38,4 +38,4 @@ class Command(BaseCommand):
do_delete_old_unclaimed_attachments(delta_weeks)
print("")
- print("Unclaimed Files deleted.")
+ print("Unclaimed files deleted.")
diff --git a/zerver/management/commands/email_mirror.py b/zerver/management/commands/email_mirror.py
index 2d3b904b03..251f550766 100644
--- a/zerver/management/commands/email_mirror.py
+++ b/zerver/management/commands/email_mirror.py
@@ -72,7 +72,7 @@ class Command(BaseCommand):
if (not settings.EMAIL_GATEWAY_BOT or not settings.EMAIL_GATEWAY_LOGIN or
not settings.EMAIL_GATEWAY_PASSWORD or not settings.EMAIL_GATEWAY_IMAP_SERVER or
not settings.EMAIL_GATEWAY_IMAP_PORT or not settings.EMAIL_GATEWAY_IMAP_FOLDER):
- raise CommandError("Please configure the Email Mirror Gateway in /etc/zulip/, "
+ raise CommandError("Please configure the email mirror gateway in /etc/zulip/, "
"or specify $ORIGINAL_RECIPIENT if piping a single mail.")
for message in get_imap_messages():
process_message(message)
diff --git a/zerver/management/commands/export.py b/zerver/management/commands/export.py
index 43bfb94c77..6ad07a2b23 100644
--- a/zerver/management/commands/export.py
+++ b/zerver/management/commands/export.py
@@ -30,15 +30,15 @@ class Command(ZulipBaseCommand):
* Sessions (everyone will need to log in again post-export)
* Users' passwords and API keys (users will need to use SSO or reset password)
* Mobile tokens for APNS/GCM (users will need to reconnect their mobile devices)
- * ScheduledEmail (Not relevant on a new server)
- * RemoteZulipServer (Unlikely to be migrated)
+ * ScheduledEmail (not relevant on a new server)
+ * RemoteZulipServer (unlikely to be migrated)
* third_party_api_results cache (this means rerending all old
messages could be expensive)
Things that will break as a result of the export:
* Passwords will not be transferred. They will all need to go
through the password reset flow to obtain a new password (unless
- they intend to only use e.g. Google Auth).
+ they intend to only use e.g. Google auth).
* Users will need to log out and re-log in to the Zulip desktop and
mobile apps. The apps now all have an option on the login page
where you can specify which Zulip server to use; your users
diff --git a/zerver/management/commands/rate_limit.py b/zerver/management/commands/rate_limit.py
index 032e5e6efb..45a1e702dc 100644
--- a/zerver/management/commands/rate_limit.py
+++ b/zerver/management/commands/rate_limit.py
@@ -41,7 +41,7 @@ class Command(ZulipBaseCommand):
try:
user_profile = get_user_profile_by_api_key(options['api_key'])
except UserProfile.DoesNotExist:
- raise CommandError("Unable to get user profile for api key {}".format(options['api_key']))
+ raise CommandError("Unable to get user profile for API key {}".format(options['api_key']))
users = [user_profile]
if options['bots']:
diff --git a/zerver/management/commands/realm_filters.py b/zerver/management/commands/realm_filters.py
index 8140dd3b17..6a68e7d77e 100644
--- a/zerver/management/commands/realm_filters.py
+++ b/zerver/management/commands/realm_filters.py
@@ -28,7 +28,7 @@ Example: ./manage.py realm_filters --realm=zulip --op=show
help='What operation to do (add, show, remove).')
parser.add_argument('pattern', metavar='', nargs='?',
help="regular expression to match")
- parser.add_argument('url_format_string', metavar='', nargs='?',
+ parser.add_argument('url_format_string', metavar='', nargs='?',
help="format string to substitute")
self.add_realm_args(parser, True)
diff --git a/zerver/management/commands/send_webhook_fixture_message.py b/zerver/management/commands/send_webhook_fixture_message.py
index 125fa6b040..b6ea82d1e3 100644
--- a/zerver/management/commands/send_webhook_fixture_message.py
+++ b/zerver/management/commands/send_webhook_fixture_message.py
@@ -36,7 +36,7 @@ approach shown above.
'into Zulip')
parser.add_argument('-u', '--url',
- help='The url on your Zulip server that you want '
+ help='The URL on your Zulip server that you want '
'to post the fixture to')
parser.add_argument('-H', '--custom-headers',
diff --git a/zerver/management/commands/soft_deactivate_users.py b/zerver/management/commands/soft_deactivate_users.py
index 7cd6f99f05..d9b29c5b70 100644
--- a/zerver/management/commands/soft_deactivate_users.py
+++ b/zerver/management/commands/soft_deactivate_users.py
@@ -82,7 +82,7 @@ class Command(ZulipBaseCommand):
else:
users_deactivated = do_auto_soft_deactivate_users(int(options['inactive_for']),
realm)
- logger.info('Soft Deactivated %d user(s)', len(users_deactivated))
+ logger.info('Soft deactivated %d user(s)', len(users_deactivated))
else:
self.print_help("./manage.py", "soft_deactivate_users")
diff --git a/zerver/management/commands/sync_ldap_user_data.py b/zerver/management/commands/sync_ldap_user_data.py
index e4b956bc9c..ca3106af85 100644
--- a/zerver/management/commands/sync_ldap_user_data.py
+++ b/zerver/management/commands/sync_ldap_user_data.py
@@ -32,7 +32,7 @@ def sync_ldap_user_data(user_profiles: List[UserProfile], deactivation_protectio
if deactivation_protection:
if not UserProfile.objects.filter(is_bot=False, is_active=True).exists():
error_msg = ("Ldap sync would have deactivated all users. This is most likely due " +
- "to a misconfiguration of ldap settings. Rolling back...\n" +
+ "to a misconfiguration of LDAP settings. Rolling back...\n" +
"Use the --force option if the mass deactivation is intended.")
logger.error(error_msg)
# Raising an exception in this atomic block will rollback the transaction.
@@ -42,7 +42,7 @@ def sync_ldap_user_data(user_profiles: List[UserProfile], deactivation_protectio
role__gte=UserProfile.ROLE_REALM_ADMINISTRATOR).exists():
error_msg = ("Ldap sync would have deactivated all administrators of realm %s. " +
"This is most likely due " +
- "to a misconfiguration of ldap settings. Rolling back...\n" +
+ "to a misconfiguration of LDAP settings. Rolling back...\n" +
"Use the --force option if the mass deactivation is intended.")
error_msg = error_msg % (string_id,)
logger.error(error_msg)
diff --git a/zerver/middleware.py b/zerver/middleware.py
index 7d96acb375..29cc9bccb5 100644
--- a/zerver/middleware.py
+++ b/zerver/middleware.py
@@ -390,7 +390,7 @@ class RateLimitMiddleware(MiddlewareMixin):
# The limit on the action that was requested is the minimum of the limits that get applied:
limit = min(result.entity.max_api_calls() for result in rate_limit_results)
response['X-RateLimit-Limit'] = str(limit)
- # Same principle applies to remaining api calls:
+ # Same principle applies to remaining API calls:
remaining_api_calls = min(result.remaining for result in rate_limit_results)
response['X-RateLimit-Remaining'] = str(remaining_api_calls)
diff --git a/zerver/migrations/0260_missed_message_addresses_from_redis_to_db.py b/zerver/migrations/0260_missed_message_addresses_from_redis_to_db.py
index 6b0c987360..03c15ae7ad 100644
--- a/zerver/migrations/0260_missed_message_addresses_from_redis_to_db.py
+++ b/zerver/migrations/0260_missed_message_addresses_from_redis_to_db.py
@@ -5,7 +5,7 @@ from django.db import migrations
from django.db.backends.postgresql.schema import DatabaseSchemaEditor
from django.db.migrations.state import StateApps
-# Imported to avoid needing to duplicate redis-related code.
+# Imported to avoid needing to duplicate Redis-related code.
from zerver.lib.redis_utils import get_redis_client
@@ -41,12 +41,12 @@ def move_missed_message_addresses_to_database(apps: StateApps, schema_editor: Da
topic_name = subject_b.decode('utf-8')
# The data model for missed-message emails has changed in two
- # key ways: We're moving it from redis to the database for
+ # key ways: We're moving it from Redis to the database for
# better persistence, and also replacing the stream + topic
# (as the reply location) with a message to reply to. Because
- # the redis data structure only had stream/topic pairs, we use
+ # the Redis data structure only had stream/topic pairs, we use
# the following migration logic to find the latest message in
- # the thread indicated by the redis data (if it exists).
+ # the thread indicated by the Redis data (if it exists).
try:
user_profile = UserProfile.objects.get(id=user_profile_id)
recipient = Recipient.objects.get(id=recipient_id)
@@ -75,19 +75,19 @@ def move_missed_message_addresses_to_database(apps: StateApps, schema_editor: Da
# The timestamp will be set to the default (now) which means
# the address will take longer to expire than it would have in
- # redis, but this small issue is probably worth the simplicity
+ # Redis, but this small issue is probably worth the simplicity
# of not having to figure out the precise timestamp.
MissedMessageEmailAddress.objects.create(message=message,
user_profile=user_profile,
email_token=generate_missed_message_token())
# We successfully transferred this missed-message email's data
- # to the database, so this message can be deleted from redis.
+ # to the database, so this message can be deleted from Redis.
redis_client.delete(key)
class Migration(migrations.Migration):
- # Atomicity is not feasible here, since we're doing operations on redis too.
- # It's better to be non-atomic on both redis and database, than atomic
- # on the database and not on redis.
+ # Atomicity is not feasible here, since we're doing operations on Redis too.
+ # It's better to be non-atomic on both Redis and database, than atomic
+ # on the database and not on Redis.
atomic = False
dependencies = [
diff --git a/zerver/models.py b/zerver/models.py
index 77e0ef351d..a955f9dba8 100644
--- a/zerver/models.py
+++ b/zerver/models.py
@@ -2490,7 +2490,7 @@ def is_cross_realm_bot_email(email: str) -> bool:
return email.lower() in settings.CROSS_REALM_BOT_EMAILS
# The Huddle class represents a group of individuals who have had a
-# Group Private Message conversation together. The actual membership
+# group private message conversation together. The actual membership
# of the Huddle is stored in the Subscription table just like with
# Streams, and a hash of that list is stored in the huddle_hash field
# below, to support efficiently mapping from a set of users to the
@@ -3025,7 +3025,7 @@ class CustomProfileFieldValue(models.Model):
return f""
# Interfaces for services
-# They provide additional functionality like parsing message to obtain query url, data to be sent to url,
+# They provide additional functionality like parsing message to obtain query URL, data to be sent to URL,
# and parsing the response.
GENERIC_INTERFACE = 'GenericService'
SLACK_INTERFACE = 'SlackOutgoingWebhookService'
diff --git a/zerver/openapi/curl_param_value_generators.py b/zerver/openapi/curl_param_value_generators.py
index c4f5e78180..4550433e7d 100644
--- a/zerver/openapi/curl_param_value_generators.py
+++ b/zerver/openapi/curl_param_value_generators.py
@@ -30,7 +30,7 @@ helpers = ZulipTestCase()
def openapi_param_value_generator(
endpoints: List[str],
) -> Callable[[Callable[[], Dict[str, object]]], Callable[[], Dict[str, object]]]:
- """This decorator is used to register openapi param value genarator functions
+ """This decorator is used to register OpenAPI param value genarator functions
with endpoints. Example usage:
@openapi_param_value_generator(["/messages/render:post"])
diff --git a/zerver/openapi/python_examples.py b/zerver/openapi/python_examples.py
index 1df6d28eb5..9ba0ef5312 100644
--- a/zerver/openapi/python_examples.py
+++ b/zerver/openapi/python_examples.py
@@ -33,7 +33,7 @@ CALLED_TEST_FUNCTIONS: Set[str] = set()
FuncT = TypeVar("FuncT", bound=Callable[..., object])
def openapi_test_function(endpoint: str) -> Callable[[FuncT], FuncT]:
- """This decorator is used to register an openapi test function with
+ """This decorator is used to register an OpenAPI test function with
its endpoint. Example usage:
@openapi_test_function("/messages/render:post")
diff --git a/zerver/openapi/test_curl_examples.py b/zerver/openapi/test_curl_examples.py
index 81f4b8b93b..12e877da6f 100644
--- a/zerver/openapi/test_curl_examples.py
+++ b/zerver/openapi/test_curl_examples.py
@@ -72,7 +72,7 @@ Error verifying the success of the API documentation curl example.
File: {file_name}
Line: {line}
-Curl Command:
+Curl command:
{curl_command}
Response:
{response}
diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml
index 9cb960f3cb..55081f1388 100644
--- a/zerver/openapi/zulip.yaml
+++ b/zerver/openapi/zulip.yaml
@@ -292,7 +292,7 @@ paths:
avatar_url:
type: string
description: |
- The url of the new avatar URL for the user.
+ The URL of the new avatar for the user.
avatar_source:
type: string
description: |
@@ -2311,7 +2311,7 @@ paths:
additionalProperties: false
description: |
Event sent to all users in a Zulip organization when the
- set of configured [Linkifiers](/help/add-a-custom-linkification-filter)
+ set of configured [linkifiers](/help/add-a-custom-linkification-filter)
for the organization has changed.
Processing this event is important to doing Markdown local echo
@@ -2335,7 +2335,7 @@ paths:
An array of tuples, where each tuple describes a linkifier.
The first element of the tuple is a
string regex pattern which represents the pattern that should
- be linkified on matching. The second element is the url with which the
+ be linkified on matching. The second element is the URL with which the
pattern matching string should be linkified with and the third element
is the ID of the realm filter.
example:
@@ -3076,7 +3076,7 @@ paths:
supported by Zulip's powerful full-text search backend.
When a narrow is not specified, it can be used to fetch a user's
- message history (We recommend paginating to 1000 messages at a time).
+ message history. (We recommend paginating to 1000 messages at a time.)
In either case, you specify an `anchor` message (or ask the server to
calculate the first unread message for you and use that as the
@@ -4675,7 +4675,7 @@ paths:
type: array
items:
type: object
- example: [{"name": "Verona", "description": "Italian City"}]
+ example: [{"name": "Verona", "description": "Italian city"}]
required: true
- $ref: "#/components/parameters/Principals"
- name: authorization_errors_fatal
@@ -5416,7 +5416,7 @@ paths:
*`email_notifications`: Whether to trigger an email notification for all
messages sent to the stream.
- *`in_home_view`: Whether to mute the stream (Legacy property)
+ *`in_home_view`: Whether to mute the stream (legacy property)
*`wildcard_mentions_notify`: whether wildcard mentions trigger notifications
as though they were personal mentions in this stream.
@@ -6040,11 +6040,11 @@ paths:
Present if `realm_filters` is present in `fetch_event_types`.
An array of tuples (fixed-length arrays) where each tuple describes
- a single realm filter ([Linkifier](/help/add-a-custom-linkification-filter).
+ a single realm filter ([linkifier](/help/add-a-custom-linkification-filter).
The first element of the tuple is a string regex pattern which represents
the pattern that should be linkified on matching.
- The second element is the url with which the
+ The second element is the URL with which the
pattern matching string should be linkified with and the third element
is the id of the realm filter.
realm_user_groups:
@@ -6875,7 +6875,7 @@ paths:
Present if `realm` is present in `fetch_event_types`.
Members whose accounts have been created at least this many days ago
- will be treated as [Full Members](/help/restrict-permissions-of-new-members)
+ will be treated as [full members](/help/restrict-permissions-of-new-members)
for the purpose of settings that restrict access to new members.
realm_digest_weekday:
type: integer
@@ -6971,7 +6971,7 @@ paths:
description: |
Present if `realm` is present in `fetch_event_types`.
- The url of the organization's [profile icon](/help/create-your-organization-profile).
+ The URL of the organization's [profile icon](/help/create-your-organization-profile).
realm_icon_source:
type: string
description: |
@@ -6995,7 +6995,7 @@ paths:
description: |
Present if `realm` is present in `fetch_event_types`.
- The url of the organization's wide logo configured in the
+ The URL of the organization's wide logo configured in the
[organization profile](/help/create-your-organization-profile).
realm_logo_source:
type: string
@@ -7014,7 +7014,7 @@ paths:
description: |
Present if `realm` is present in `fetch_event_types`.
- The url of the organization's night theme wide-format logo configured in the
+ The URL of the organization's night theme wide-format logo configured in the
[organization profile](/help/create-your-organization-profile).
realm_night_logo_source:
type: string
@@ -7195,7 +7195,7 @@ paths:
url_pattern:
type: string
description: |
- The regex pattern of the url of a profile page
+ The regex pattern of the URL of a profile page
on the external site.
jitsi_server_url:
type: string
@@ -7348,7 +7348,7 @@ paths:
description: |
Present if `realm_user` is present in `fetch_event_types`.
- The url of the avatar URL for the current user at 100x100
+ The URL of the avatar for the current user at 100x100
resolution. See also `avatar_url_medium`.
can_create_streams:
type: boolean
@@ -7517,7 +7517,7 @@ paths:
type: boolean
dev:
description: |
- Whether the user can authenticate using development api key.
+ Whether the user can authenticate using development API key.
type: boolean
email:
description: |
@@ -7525,35 +7525,35 @@ paths:
type: boolean
ldap:
description: |
- Whether the user can authenticate using ldap.
+ Whether the user can authenticate using LDAP.
type: boolean
remoteuser:
description: |
- Whether the user can authenticate using remoteuser.
+ Whether the user can authenticate using REMOTE_USER.
type: boolean
github:
description: |
- Whether the user can authenticate using their github account.
+ Whether the user can authenticate using their GitHub account.
type: boolean
azuread:
description: |
- Whether the user can authenticate using their azuread account.
+ Whether the user can authenticate using their Azure Active Directory account.
type: boolean
gitlab:
description: |
- Whether the user can authenticate using their gitlab account.
+ Whether the user can authenticate using their GitLab account.
type: boolean
apple:
description: |
- Whether the user can authenticate using their apple account.
+ Whether the user can authenticate using their Apple account.
type: boolean
google:
description: |
- Whether the user can authenticate using their google account.
+ Whether the user can authenticate using their Google account.
type: boolean
saml:
description: |
- Whether the user can authenticate using saml.
+ Whether the user can authenticate using SAML.
type: boolean
external_authentication_methods:
type: array
@@ -8249,7 +8249,7 @@ paths:
The user_ids of the recipients of the message being typed. Typing
notifications are only supported for private messages. Send a
JSON-encoded list of user_ids. (Use a list even if there is only one
- recipient.).
+ recipient.)
**Changes**: Before Zulip 2.0, this parameter accepted only a JSON-encoded
list of email addresses. Support for the email address-based format was
@@ -8480,7 +8480,7 @@ paths:
members:
type: array
description: |
- The integer User IDs of the user group members.
+ The integer user IDs of the user group members.
items:
type: integer
name:
@@ -8548,7 +8548,7 @@ paths:
operationId: zulip_outgoing_webhooks
tags: ["webhooks"]
description: |
- Outgoing Webhooks allows to build or set up Zulip integrations which are
+ Outgoing webhooks allows to build or set up Zulip integrations which are
notified when certain types of messages are sent in Zulip.
responses:
"200":
@@ -8612,7 +8612,7 @@ paths:
The content/body of the message rendered in HTML.
example:
{
- "data": "@**Outgoing Webhook Test** Zulip is the world\u2019s most productive group chat!",
+ "data": "@**Outgoing webhook test** Zulip is the world\u2019s most productive group chat!",
"trigger": "mention",
"token": "xvOzfurIutdRRVLzpXrIIHXJvNfaJLJ0",
"message":
@@ -8626,10 +8626,10 @@ paths:
"topic_links": [],
"sender_full_name": "Iago",
"avatar_url": "https://secure.gravatar.com/avatar/1f4f1575bf002ae562fea8fc4b861b09?d=identicon&version=1",
- "rendered_content": "![](\"/thumbnail?url=https%3A%2F%2Fwww.google.com%2Fimages%2Fsrpr%2Flogo4w.png&size=thumbnail\")
",
+ "input": "[Google link](https://www.google.com/images/srpr/logo4w.png)",
+ "expected_output": "\n",
"backend_only_rendering": true,
- "text_content": "Google Link\n"
+ "text_content": "Google link\n"
},
{
"name": "only_non_image_link",
diff --git a/zerver/tests/fixtures/mattermost_fixtures/direct_channel/export.json b/zerver/tests/fixtures/mattermost_fixtures/direct_channel/export.json
index c4b056c699..010a15b66e 100644
--- a/zerver/tests/fixtures/mattermost_fixtures/direct_channel/export.json
+++ b/zerver/tests/fixtures/mattermost_fixtures/direct_channel/export.json
@@ -15,7 +15,7 @@
{"type":"direct_channel","direct_channel":{"members":["ron","harry", "ginny"],"favorited_by":null,"header":""}}
{"type":"direct_post","direct_post":{"channel_members":["ron","harry"],"user":"ron","message":"hey harry","create_at":1566376137676,"flagged_by":null,"reactions":null,"replies":null,"attachments":null}}
{"type":"direct_post","direct_post":{"channel_members":["ron","harry"],"user":"harry","message":"what's up","create_at":1566376318568,"flagged_by":null,"reactions":null,"replies":null,"attachments":null}}
-{"type":"direct_post","direct_post":{"channel_members":["ron","harry","ginny"],"user":"ginny","message":"Who is going to Hogesmead this weekend?","create_at":1566376226493,"flagged_by":null,"reactions":null,"replies":null,"attachments":null}}
+{"type":"direct_post","direct_post":{"channel_members":["ron","harry","ginny"],"user":"ginny","message":"Who is going to Hogsmeade this weekend?","create_at":1566376226493,"flagged_by":null,"reactions":null,"replies":null,"attachments":null}}
{"type":"direct_post","direct_post":{"channel_members":["ron","harry","ginny"],"user":"harry","message":"I am going.","create_at":1566376311350,"flagged_by":null,"reactions":null,"replies":null,"attachments":null}}
{"type":"direct_post","direct_post":{"channel_members":["ron","harry","ginny"],"user":"ron","message":"I am going as well","create_at":1566376286363,"flagged_by":null,"reactions":null,"replies":null,"attachments":null}}
{"type":"direct_post","direct_post":{"channel_members":["harry","voldemort"],"user":"voldemort","message":"Hey Harry.","create_at":1566376318569,"flagged_by":null,"reactions":null,"replies":null,"attachments":null}}
diff --git a/zerver/tests/test_alert_words.py b/zerver/tests/test_alert_words.py
index a72eda0956..09d3eeba5d 100644
--- a/zerver/tests/test_alert_words.py
+++ b/zerver/tests/test_alert_words.py
@@ -184,8 +184,8 @@ class AlertWordTests(ZulipTestCase):
self.assertTrue(self.message_does_alert(user, "Case of ONE, won't stop me"))
# We don't cause alerts for matches in URLs.
- self.assertFalse(self.message_does_alert(user, "Don't alert on http://t.co/one/ urls"))
- self.assertFalse(self.message_does_alert(user, "Don't alert on http://t.co/one urls"))
+ self.assertFalse(self.message_does_alert(user, "Don't alert on http://t.co/one/ URLs"))
+ self.assertFalse(self.message_does_alert(user, "Don't alert on http://t.co/one URLs"))
def test_update_alert_words(self) -> None:
user = self.get_user()
diff --git a/zerver/tests/test_auth_backends.py b/zerver/tests/test_auth_backends.py
index 7b7e4be5c1..d0355ef232 100644
--- a/zerver/tests/test_auth_backends.py
+++ b/zerver/tests/test_auth_backends.py
@@ -858,7 +858,7 @@ class SocialAuthBase(DesktopFlowTestingLib, ZulipTestCase):
# redirected back to the registered redirect uri.
# We register callbacks for the key URLs on Identity Provider that
- # auth completion url will call
+ # auth completion URL will call
with responses.RequestsMock(assert_all_requests_are_fired=False) as requests_mock:
requests_mock.add(
requests_mock.POST,
@@ -1368,11 +1368,11 @@ class SocialAuthBase(DesktopFlowTestingLib, ZulipTestCase):
result = self.social_auth_test(account_data_dict,
expect_choose_email_screen=True,
subdomain=subdomain, is_signup=True)
- # Full name should get populated from ldap:
+ # Full name should get populated from LDAP:
self.stage_two_of_registration(result, realm, subdomain, email, name, "New LDAP fullname",
skip_registration_form=True)
- # Now try a user that doesn't exist in ldap:
+ # Now try a user that doesn't exist in LDAP:
email = self.nonreg_email("alice")
name = "Alice Social"
account_data_dict = self.get_account_data_dict(email=email, name=name)
@@ -1380,7 +1380,7 @@ class SocialAuthBase(DesktopFlowTestingLib, ZulipTestCase):
expect_choose_email_screen=True,
subdomain=subdomain, is_signup=True)
# Full name should get populated as provided by the social backend, because
- # this user isn't in the ldap dictionary:
+ # this user isn't in the LDAP dictionary:
self.stage_two_of_registration(result, realm, subdomain, email, name, name,
skip_registration_form=self.BACKEND_CLASS.full_name_validated)
self.assertEqual(log_warn.output, [f'WARNING:root:New account email {email} could not be found in LDAP'])
@@ -1388,8 +1388,8 @@ class SocialAuthBase(DesktopFlowTestingLib, ZulipTestCase):
@override_settings(TERMS_OF_SERVICE=None)
def test_social_auth_with_ldap_auth_registration_from_confirmation(self) -> None:
"""
- This test checks that in configurations that use the ldap authentication backend
- and a social backend, it is possible to create non-ldap users via the social backend.
+ This test checks that in configurations that use the LDAP authentication backend
+ and a social backend, it is possible to create non-LDAP users via the social backend.
"""
self.init_default_ldap_database()
email = self.nonreg_email("alice")
@@ -1413,11 +1413,11 @@ class SocialAuthBase(DesktopFlowTestingLib, ZulipTestCase):
expect_choose_email_screen=True,
subdomain=subdomain, is_signup=True)
# Full name should get populated as provided by the social backend, because
- # this user isn't in the ldap dictionary:
+ # this user isn't in the LDAP dictionary:
self.stage_two_of_registration(result, realm, subdomain, email, name, name,
skip_registration_form=self.BACKEND_CLASS.full_name_validated)
self.assertEqual(log_warn.output, [f'WARNING:root:New account email {email} could not be found in LDAP'])
- self.assertEqual(log_debug.output, [f'DEBUG:zulip.ldap:ZulipLDAPAuthBackend: No ldap user matching django_to_ldap_username result: {email}. Input username: {email}'])
+ self.assertEqual(log_debug.output, [f'DEBUG:zulip.ldap:ZulipLDAPAuthBackend: No LDAP user matching django_to_ldap_username result: {email}. Input username: {email}'])
def test_social_auth_complete(self) -> None:
with mock.patch('social_core.backends.oauth.BaseOAuth2.process_error',
@@ -1867,7 +1867,7 @@ class SAMLAuthBackendTest(SocialAuthBase):
self.assert_in_success_response(["Configuration error", "SAML authentication"], result)
result = self.client_get(f'/accounts/{action}/social/saml/')
- # No matching url pattern.
+ # No matching URL pattern.
self.assertEqual(result.status_code, 404)
def test_social_auth_saml_require_limit_to_subdomains(self) -> None:
@@ -2178,7 +2178,7 @@ class AppleIdAuthBackendTest(AppleAuthMixin, SocialAuthBase):
self.assertEqual(result.status_code, 302)
self.assertIn('login', result.url)
- # (2) Check if auth fails when a state sent has no valid data stored in redis.
+ # (2) Check if auth fails when a state sent has no valid data stored in Redis.
fake_state = "fa42e4ccdb630f0070c1daab70ad198d8786d4b639cd7a1b4db4d5a13c623060"
result = self.client_post('/complete/apple/', {'state': fake_state})
self.assertEqual(result.status_code, 302)
@@ -2392,7 +2392,7 @@ class GitHubAuthBackendTest(SocialAuthBase):
# that requires "choose email" screen;
self.assert_in_success_response(["Select account"], result)
# Verify that all the emails returned by GitHub auth
- # are in the "choose email" screen.
+ # Are in the "choose email" screen.
all_emails_verified = True
for email_data_dict in self.email_data:
email = email_data_dict["email"]
@@ -3353,19 +3353,19 @@ class ExternalMethodDictsTests(ZulipTestCase):
):
# Calling get_external_method_dicts without a realm returns all methods configured on the server:
external_auth_methods = get_external_method_dicts()
- # 1 IdP enabled for all realms + a dict for github auth
+ # 1 IdP enabled for all realms + a dict for GitHub auth
self.assert_length(external_auth_methods, 2)
self.assertEqual([external_auth_methods[0]['name'], external_auth_methods[1]['name']],
['saml:test_idp', 'github'])
external_auth_methods = get_external_method_dicts(get_realm("zulip"))
- # Only test_idp enabled for the zulip realm, + github auth.
+ # Only test_idp enabled for the zulip realm, + GitHub auth.
self.assert_length(external_auth_methods, 2)
self.assertEqual([external_auth_methods[0]['name'], external_auth_methods[1]['name']],
['saml:test_idp', 'github'])
external_auth_methods = get_external_method_dicts(get_realm("zephyr"))
- # Both idps enabled for the zephyr realm, + github auth.
+ # Both idps enabled for the zephyr realm, + GitHub auth.
self.assert_length(external_auth_methods, 3)
self.assertEqual({external_auth_methods[0]['name'], external_auth_methods[1]['name']},
{'saml:test_idp', 'saml:test_idp2'})
@@ -4074,7 +4074,7 @@ class DjangoToLDAPUsernameTests(ZulipTestCase):
def test_authenticate_to_ldap_via_email(self) -> None:
"""
With AUTH_LDAP_REVERSE_EMAIL_SEARCH configured, django_to_ldap_username
- should be able to translate an email to ldap username,
+ should be able to translate an email to LDAP username,
and thus it should be possible to authenticate through user_profile.delivery_email.
"""
realm = get_realm("zulip")
@@ -4252,7 +4252,7 @@ class TestLDAP(ZulipLDAPTestCase):
password="doesnt_matter",
realm=get_realm('zulip'))
self.assertEqual(log_debug.output, [
- 'DEBUG:zulip.ldap:ZulipLDAPAuthBackend: No ldap user matching django_to_ldap_username result: nonexistent. Input username: nonexistent@zulip.com'
+ 'DEBUG:zulip.ldap:ZulipLDAPAuthBackend: No LDAP user matching django_to_ldap_username result: nonexistent. Input username: nonexistent@zulip.com'
])
self.assertIs(user, None)
@@ -4822,7 +4822,7 @@ class TestQueryLDAP(ZulipLDAPTestCase):
with self.settings(AUTH_LDAP_USER_ATTR_MAP={'full_name': 'cn'},
LDAP_EMAIL_ATTR='mail'):
# This will look up the user by email in our test dictionary,
- # should successfully find hamlet's ldap entry.
+ # should successfully find hamlet's LDAP entry.
values = query_ldap(self.example_email('hamlet'))
self.assertEqual(len(values), 2)
self.assertIn('full_name: King Hamlet', values)
diff --git a/zerver/tests/test_bots.py b/zerver/tests/test_bots.py
index 4afea31b43..2aab06ee80 100644
--- a/zerver/tests/test_bots.py
+++ b/zerver/tests/test_bots.py
@@ -341,7 +341,7 @@ class BotTest(ZulipTestCase, UploadSerializeMixin):
list of subscriptions and confirm the right number of events
are generated.
When 'principals' has a bot, no notification message event or invitation email
- is sent when add_subscriptions_backend is called in the above api call.
+ is sent when add_subscriptions_backend is called in the above API call.
"""
hamlet = self.example_user('hamlet')
iago = self.example_user('iago')
diff --git a/zerver/tests/test_camo.py b/zerver/tests/test_camo.py
index 3ef7c1e28a..441e1c9adb 100644
--- a/zerver/tests/test_camo.py
+++ b/zerver/tests/test_camo.py
@@ -3,12 +3,12 @@ from zerver.lib.test_classes import ZulipTestCase
class CamoURLTest(ZulipTestCase):
def test_legacy_camo_url(self) -> None:
- # Test with valid hex and url pair
+ # Test with valid hex and URL pair
result = self.client_get("/external_content/0f50f0bda30b6e65e9442c83ddb4076c74e75f96/687474703a2f2f7777772e72616e646f6d2e736974652f696d616765732f666f6f6261722e6a706567")
self.assertEqual(result.status_code, 302, result)
self.assertIn('/filters:no_upscale():quality(100)/aHR0cDovL3d3dy5yYW5kb20uc2l0ZS9pbWFnZXMvZm9vYmFyLmpwZWc=/source_type/external', result.url)
- # Test with invalid hex and url pair
+ # Test with invalid hex and URL pair
result = self.client_get("/external_content/074c5e6c9c6d4ce97db1c740d79dc561cf7eb379/687474703a2f2f7777772e72616e646f6d2e736974652f696d616765732f666f6f6261722e6a706567")
self.assertEqual(result.status_code, 403, result)
self.assert_in_response("Not a valid URL.", result)
diff --git a/zerver/tests/test_custom_profile_data.py b/zerver/tests/test_custom_profile_data.py
index eecf414205..9f5b24670e 100644
--- a/zerver/tests/test_custom_profile_data.py
+++ b/zerver/tests/test_custom_profile_data.py
@@ -237,7 +237,7 @@ class CreateCustomProfileFieldTest(CustomProfileFieldTestCase):
'subtype': 'custom',
}).decode()
result = self.client_post("/json/realm/profile_fields", info=data)
- self.assert_json_error(result, 'Custom external account must define url pattern')
+ self.assert_json_error(result, 'Custom external account must define URL pattern')
data["field_data"] = orjson.dumps({
'subtype': 'custom',
diff --git a/zerver/tests/test_event_queue.py b/zerver/tests/test_event_queue.py
index 3c47909a4b..f3f8beff47 100644
--- a/zerver/tests/test_event_queue.py
+++ b/zerver/tests/test_event_queue.py
@@ -197,7 +197,7 @@ class MissedMessageNotificationsTest(ZulipTestCase):
all_public_streams=True,
apply_markdown=True,
client_gravatar=True,
- client_type_name='home grown api program',
+ client_type_name='home grown API program',
event_types=['message'],
last_connection_time=time.time(),
queue_timeout=0,
diff --git a/zerver/tests/test_external.py b/zerver/tests/test_external.py
index 5d35b50b7d..c601a9e451 100644
--- a/zerver/tests/test_external.py
+++ b/zerver/tests/test_external.py
@@ -48,7 +48,7 @@ class RateLimitTests(ZulipTestCase):
# Some tests here can be somewhat timing-sensitive in a way
# that can't be eliminated, e.g. due to testing things that rely
- # on redis' internal timing mechanism which we can't mock.
+ # on Redis' internal timing mechanism which we can't mock.
# The first API request when running a suite of tests is slow
# and can take multiple seconds. This is not a problem when running
# multiple tests, but if an individual, time-sensitive test from this class
diff --git a/zerver/tests/test_home.py b/zerver/tests/test_home.py
index 0e5d13a8dc..346181046d 100644
--- a/zerver/tests/test_home.py
+++ b/zerver/tests/test_home.py
@@ -905,7 +905,7 @@ class HomeTest(ZulipTestCase):
with self.assertLogs(logger_string, level='INFO') as info_log:
do_soft_deactivate_users([long_term_idle_user])
self.assertEqual(info_log.output, [
- f'INFO:{logger_string}:Soft Deactivated user {long_term_idle_user.id}',
+ f'INFO:{logger_string}:Soft deactivated user {long_term_idle_user.id}',
f'INFO:{logger_string}:Soft-deactivated batch of 1 users; 0 remain to process'
])
@@ -930,7 +930,7 @@ class HomeTest(ZulipTestCase):
with self.assertLogs(logger_string, level='INFO') as info_log:
do_soft_deactivate_users([long_term_idle_user])
self.assertEqual(info_log.output, [
- f'INFO:{logger_string}:Soft Deactivated user {long_term_idle_user.id}',
+ f'INFO:{logger_string}:Soft deactivated user {long_term_idle_user.id}',
f'INFO:{logger_string}:Soft-deactivated batch of 1 users; 0 remain to process'
])
@@ -959,7 +959,7 @@ class HomeTest(ZulipTestCase):
with self.assertLogs(logger_string, level='INFO') as info_log:
do_soft_deactivate_users([long_term_idle_user])
self.assertEqual(info_log.output, [
- f'INFO:{logger_string}:Soft Deactivated user {long_term_idle_user.id}',
+ f'INFO:{logger_string}:Soft deactivated user {long_term_idle_user.id}',
f'INFO:{logger_string}:Soft-deactivated batch of 1 users; 0 remain to process'
])
diff --git a/zerver/tests/test_i18n.py b/zerver/tests/test_i18n.py
index 781a95e95d..1b4415015f 100644
--- a/zerver/tests/test_i18n.py
+++ b/zerver/tests/test_i18n.py
@@ -87,7 +87,7 @@ class TranslationTestCase(ZulipTestCase):
]
for lang, word in languages:
- # Applying str function to LANGUAGE_COOKIE_NAME to convert unicode
+ # Applying str function to LANGUAGE_COOKIE_NAME to convert Unicode
# into an ascii otherwise SimpleCookie will raise an exception
self.client.cookies = SimpleCookie({str(settings.LANGUAGE_COOKIE_NAME): lang})
diff --git a/zerver/tests/test_integrations_dev_panel.py b/zerver/tests/test_integrations_dev_panel.py
index 8aab019845..bd2155402e 100644
--- a/zerver/tests/test_integrations_dev_panel.py
+++ b/zerver/tests/test_integrations_dev_panel.py
@@ -87,7 +87,7 @@ class TestIntegrationsDevPanel(ZulipTestCase):
def test_check_send_webhook_fixture_message_for_success_with_headers_and_non_json_fixtures(self) -> None:
bot = get_user('webhook-bot@zulip.com', self.zulip_realm)
- url = f"/api/v1/external/wordpress?api_key={bot.api_key}&stream=Denmark&topic=Wordpress Notifications"
+ url = f"/api/v1/external/wordpress?api_key={bot.api_key}&stream=Denmark&topic=WordPress Notifications"
target_url = "/devtools/integrations/check_send_webhook_fixture_message"
with open("zerver/webhooks/wordpress/fixtures/publish_post_no_data_provided.txt") as f:
body = f.read()
@@ -106,7 +106,7 @@ class TestIntegrationsDevPanel(ZulipTestCase):
expected_message = "New post published:\n* [New WordPress Post](WordPress Post URL)"
self.assertEqual(latest_msg.content, expected_message)
self.assertEqual(Stream.objects.get(id=latest_msg.recipient.type_id).name, "Denmark")
- self.assertEqual(latest_msg.topic_name(), "Wordpress Notifications")
+ self.assertEqual(latest_msg.topic_name(), "WordPress Notifications")
def test_get_fixtures_for_nonexistant_integration(self) -> None:
target_url = "/devtools/integrations/somerandomnonexistantintegration/fixtures"
@@ -182,7 +182,7 @@ class TestIntegrationsDevPanel(ZulipTestCase):
def test_send_all_webhook_fixture_messages_for_success_with_non_json_fixtures(self) -> None:
bot = get_user('webhook-bot@zulip.com', self.zulip_realm)
- url = f"/api/v1/external/wordpress?api_key={bot.api_key}&stream=Denmark&topic=Wordpress Bulk Notifications"
+ url = f"/api/v1/external/wordpress?api_key={bot.api_key}&stream=Denmark&topic=WordPress Bulk Notifications"
target_url = "/devtools/integrations/send_all_webhook_fixture_messages"
data = {
diff --git a/zerver/tests/test_link_embed.py b/zerver/tests/test_link_embed.py
index 31d731fb2e..1a302ec1ac 100644
--- a/zerver/tests/test_link_embed.py
+++ b/zerver/tests/test_link_embed.py
@@ -431,7 +431,7 @@ class PreviewTestCase(ZulipTestCase):
@override_settings(INLINE_URL_EMBED_PREVIEW=True)
def test_inline_relative_url_embed_preview(self) -> None:
- # Relative urls should not be sent for url preview.
+ # Relative URLs should not be sent for URL preview.
with mock_queue_publish('zerver.lib.actions.queue_json_publish') as patched:
self.send_personal_message(
self.example_user('prospero'),
@@ -442,7 +442,7 @@ class PreviewTestCase(ZulipTestCase):
def test_inline_url_embed_preview_with_relative_image_url(self) -> None:
with_preview_relative = '\n'
- # Try case where the opengraph image is a relative url.
+ # Try case where the Open Graph image is a relative URL.
msg = self._send_message_with_test_org_url(sender=self.example_user('prospero'), relative_url=True)
self.assertEqual(msg.rendered_content, with_preview_relative)
@@ -744,7 +744,7 @@ class PreviewTestCase(ZulipTestCase):
@override_settings(INLINE_URL_EMBED_PREVIEW=True)
def test_custom_title_replaces_youtube_url_title(self) -> None:
- url = '[Youtube link](https://www.youtube.com/watch?v=eSJTXC7Ixgg)'
+ url = '[YouTube link](https://www.youtube.com/watch?v=eSJTXC7Ixgg)'
with mock_queue_publish('zerver.lib.actions.queue_json_publish'):
msg_id = self.send_personal_message(
self.example_user('hamlet'),
@@ -766,9 +766,9 @@ class PreviewTestCase(ZulipTestCase):
lambda *args, **kwargs: mocked_data):
FetchLinksEmbedData().consume(event)
self.assertTrue(
- 'INFO:root:Time spent on get_link_embed_data for [Youtube link](https://www.youtube.com/watch?v=eSJTXC7Ixgg):' in info_logs.output[0]
+ 'INFO:root:Time spent on get_link_embed_data for [YouTube link](https://www.youtube.com/watch?v=eSJTXC7Ixgg):' in info_logs.output[0]
)
msg.refresh_from_db()
- expected_content = '\n
'
+ expected_content = '\n'
self.assertEqual(expected_content, msg.rendered_content)
diff --git a/zerver/tests/test_logging_handlers.py b/zerver/tests/test_logging_handlers.py
index 4ecbbe62a8..bffdad6f97 100644
--- a/zerver/tests/test_logging_handlers.py
+++ b/zerver/tests/test_logging_handlers.py
@@ -63,7 +63,7 @@ class AdminNotifyHandlerTest(ZulipTestCase):
"""A random exception passes happily through AdminNotifyHandler"""
handler = self.get_admin_zulip_handler()
try:
- raise Exception("Testing Error!")
+ raise Exception("Testing error!")
except Exception:
exc_info = sys.exc_info()
record = self.logger.makeRecord('name', logging.ERROR, 'function', 16,
@@ -162,7 +162,7 @@ class AdminNotifyHandlerTest(ZulipTestCase):
# Now simulate a DisallowedHost exception
def get_host_error() -> None:
- raise Exception("Get Host Failure!")
+ raise Exception("Get host failure!")
orig_get_host = record.request.get_host
record.request.get_host = get_host_error
report = self.run_handler(record)
diff --git a/zerver/tests/test_management_commands.py b/zerver/tests/test_management_commands.py
index 6d6bc554a1..b2f80b45c7 100644
--- a/zerver/tests/test_management_commands.py
+++ b/zerver/tests/test_management_commands.py
@@ -421,7 +421,7 @@ class TestConvertMattermostData(ZulipTestCase):
output_dir=os.path.realpath(output_dir),
)
self.assertEqual(mock_print.mock_calls, [
- call('Converting Data ...')
+ call('Converting data ...')
])
@skipUnless(settings.ZILENCER_ENABLED, "requires zilencer")
diff --git a/zerver/tests/test_markdown.py b/zerver/tests/test_markdown.py
index 96c344ff15..804347af1d 100644
--- a/zerver/tests/test_markdown.py
+++ b/zerver/tests/test_markdown.py
@@ -516,7 +516,7 @@ class MarkdownTest(ZulipTestCase):
converted = markdown_convert_wrapper(msg)
self.assertIn(thumbnail_img, converted)
- # Any url which is not an external link and doesn't start with
+ # Any URL which is not an external link and doesn't start with
# /user_uploads/ is not thumbnailed
msg = '[foobar](/static/images/cute/turtle.png)'
thumbnail_img = '
'
@@ -603,7 +603,7 @@ class MarkdownTest(ZulipTestCase):
@override_settings(INLINE_IMAGE_PREVIEW=True)
def test_corrected_image_source(self) -> None:
- # testing only wikipedia because linx.li urls can be expected to expire
+ # testing only Wikipedia because linx.li URLs can be expected to expire
content = 'https://en.wikipedia.org/wiki/File:Wright_of_Derby,_The_Orrery.jpg'
expected = '
'
@@ -721,17 +721,17 @@ class MarkdownTest(ZulipTestCase):
self.assertEqual(converted, '
')
def test_inline_youtube_preview(self) -> None:
- # Test youtube urls in spoilers
- msg = """\n```spoiler Check out this Pycon Video\nhttps://www.youtube.com/watch?v=0c46YHS3RY8\n```"""
+ # Test YouTube URLs in spoilers
+ msg = """\n```spoiler Check out this PyCon video\nhttps://www.youtube.com/watch?v=0c46YHS3RY8\n```"""
converted = markdown_convert_wrapper(msg)
- self.assertEqual(converted, '')
+ self.assertEqual(converted, '')
- # Test youtube urls in normal messages.
- msg = '[Youtube link](https://www.youtube.com/watch?v=0c46YHS3RY8)'
+ # Test YouTube URLs in normal messages.
+ msg = '[YouTube link](https://www.youtube.com/watch?v=0c46YHS3RY8)'
converted = markdown_convert_wrapper(msg)
- self.assertEqual(converted, '\n
')
+ self.assertEqual(converted, '\n')
msg = 'https://www.youtube.com/watch?v=0c46YHS3RY8\n\nSample text\n\nhttps://www.youtube.com/watch?v=lXFO2ULktEI'
converted = markdown_convert_wrapper(msg)
@@ -892,7 +892,7 @@ class MarkdownTest(ZulipTestCase):
make_link('http://twitter.com/wdaher/status/287977969287315460'),
make_inline_twitter_preview('http://twitter.com/wdaher/status/287977969287315460', emoji_in_tweet_html)))
- # Test twitter previews in spoiler tags.
+ # Test Twitter previews in spoiler tags.
msg = '```spoiler secret tweet\nTweet: http://twitter.com/wdaher/status/287977969287315456\n```'
converted = markdown_convert_wrapper(msg)
diff --git a/zerver/tests/test_mattermost_importer.py b/zerver/tests/test_mattermost_importer.py
index 6b8bd48021..910ee8c697 100644
--- a/zerver/tests/test_mattermost_importer.py
+++ b/zerver/tests/test_mattermost_importer.py
@@ -670,7 +670,7 @@ class MatterMostImporter(ZulipTestCase):
self.assertEqual(len(huddle_messages), 3)
self.assertEqual(len(set(huddle_recipients)), 1)
self.assertEqual(huddle_messages[0].sender.email, "ginny@zulip.com")
- self.assertEqual(huddle_messages[0].content, "Who is going to Hogesmead this weekend?\n\n")
+ self.assertEqual(huddle_messages[0].content, "Who is going to Hogsmeade this weekend?\n\n")
personal_messages = messages.filter(recipient__type=Recipient.PERSONAL).order_by("date_sent")
personal_recipients = personal_messages.values_list("recipient", flat=True)
diff --git a/zerver/tests/test_message_fetch.py b/zerver/tests/test_message_fetch.py
index 9080aa1f55..b1f1527bde 100644
--- a/zerver/tests/test_message_fetch.py
+++ b/zerver/tests/test_message_fetch.py
@@ -1614,7 +1614,7 @@ class GetOldMessagesTest(ZulipTestCase):
def test_get_messages_with_narrow_stream_mit_unicode_regex(self) -> None:
"""
- A request for old messages for a user in the mit.edu relam with unicode
+ A request for old messages for a user in the mit.edu relam with Unicode
stream name should be correctly escaped in the database query.
"""
user = self.mit_user('starnine')
@@ -1648,7 +1648,7 @@ class GetOldMessagesTest(ZulipTestCase):
def test_get_messages_with_narrow_topic_mit_unicode_regex(self) -> None:
"""
- A request for old messages for a user in the mit.edu realm with unicode
+ A request for old messages for a user in the mit.edu realm with Unicode
topic name should be correctly escaped in the database query.
"""
mit_user_profile = self.mit_user("starnine")
@@ -1875,7 +1875,7 @@ class GetOldMessagesTest(ZulipTestCase):
self.assertEqual(len(multi_search_result['messages']), 1)
self.assertEqual(multi_search_result['messages'][0]['match_content'], '"
+ - url: ""
```
{!congrats.md!}
diff --git a/zerver/webhooks/alertmanager/view.py b/zerver/webhooks/alertmanager/view.py
index 2ec11e5ccb..8e651fe312 100644
--- a/zerver/webhooks/alertmanager/view.py
+++ b/zerver/webhooks/alertmanager/view.py
@@ -10,7 +10,7 @@ from zerver.lib.webhooks.common import check_send_webhook_message
from zerver.models import UserProfile
-@webhook_view('AlertManager')
+@webhook_view('Alertmanager')
@has_request_variables
def api_alertmanager_webhook(request: HttpRequest, user_profile: UserProfile,
payload: Dict[str, Any] = REQ(argument_type='body')) -> HttpResponse:
diff --git a/zerver/webhooks/ansibletower/view.py b/zerver/webhooks/ansibletower/view.py
index 40a2355d63..5e5f5f2833 100644
--- a/zerver/webhooks/ansibletower/view.py
+++ b/zerver/webhooks/ansibletower/view.py
@@ -18,7 +18,7 @@ ANSIBLETOWER_JOB_MESSAGE_TEMPLATE = """
ANSIBLETOWER_JOB_HOST_ROW_TEMPLATE = '* {hostname}: {status}\n'
-@webhook_view('Ansibletower')
+@webhook_view('AnsibleTower')
@has_request_variables
def api_ansibletower_webhook(request: HttpRequest, user_profile: UserProfile,
payload: Dict[str, Any]=REQ(argument_type='body')) -> HttpResponse:
diff --git a/zerver/webhooks/beanstalk/view.py b/zerver/webhooks/beanstalk/view.py
index 8f888f879c..7125021ecc 100644
--- a/zerver/webhooks/beanstalk/view.py
+++ b/zerver/webhooks/beanstalk/view.py
@@ -40,7 +40,7 @@ def _transform_commits_list_to_common_format(commits: List[Dict[str, Any]]) -> L
})
return new_commits_list
-# Beanstalk's web hook UI rejects url with a @ in the username section of a url
+# Beanstalk's web hook UI rejects URL with a @ in the username section
# So we ask the user to replace them with %40
# We manually fix the username here before passing it along to @authenticated_rest_api_view
def beanstalk_decoder(view_func: ViewFuncT) -> ViewFuncT:
@@ -66,9 +66,9 @@ def beanstalk_decoder(view_func: ViewFuncT) -> ViewFuncT:
def api_beanstalk_webhook(request: HttpRequest, user_profile: UserProfile,
payload: Dict[str, Any]=REQ(validator=check_dict([])),
branches: Optional[str]=REQ(default=None)) -> HttpResponse:
- # Beanstalk supports both SVN and git repositories
+ # Beanstalk supports both SVN and Git repositories
# We distinguish between the two by checking for a
- # 'uri' key that is only present for git repos
+ # 'uri' key that is only present for Git repos
git_repo = 'uri' in payload
if git_repo:
if branches is not None and branches.find(payload['branch']) == -1:
diff --git a/zerver/webhooks/beeminder/view.py b/zerver/webhooks/beeminder/view.py
index e75b8243f0..8873cdcd03 100644
--- a/zerver/webhooks/beeminder/view.py
+++ b/zerver/webhooks/beeminder/view.py
@@ -19,7 +19,7 @@ def get_time(payload: Dict[str, Any]) -> Any:
time_remaining = (losedate - time.time())/3600
return time_remaining
-@webhook_view("beeminder")
+@webhook_view("Beeminder")
@has_request_variables
def api_beeminder_webhook(request: HttpRequest, user_profile: UserProfile,
payload: Dict[str, Any]=REQ(argument_type='body')) -> HttpResponse:
diff --git a/zerver/webhooks/bitbucket3/tests.py b/zerver/webhooks/bitbucket3/tests.py
index 4fb156ca71..4941784e73 100644
--- a/zerver/webhooks/bitbucket3/tests.py
+++ b/zerver/webhooks/bitbucket3/tests.py
@@ -8,7 +8,7 @@ class Bitbucket3HookTests(WebhookTestCase):
URL_TEMPLATE = "/api/v1/external/bitbucket3?stream={stream}&api_key={api_key}"
FIXTURE_DIR_NAME = "bitbucket3"
- # Diagnostics Events:
+ # Diagnostics events:
def test_ping(self) -> None:
expected_message = "Congratulations! The Bitbucket Server webhook was configured successfully!"
self.check_webhook("diagnostics_ping", "Bitbucket Server Ping", expected_message)
@@ -18,7 +18,7 @@ class Bitbucket3HookTests(WebhookTestCase):
expected_message = "Congratulations! The Bitbucket Server webhook was configured successfully!"
self.check_webhook("diagnostics_ping", "my topic", expected_message)
- # Core Repo Events:
+ # Core repo events:
def test_commit_comment_added(self) -> None:
expected_message = """[hypro999](http://139.59.64.214:7990/users/hypro999) commented on [508d1b6](http://139.59.64.214:7990/projects/SBOX/repos/sandbox/commits/508d1b67f1f8f3a25f543a030a7a178894aa9907):\n~~~ quote\nJust an arbitrary comment on a commit.\n~~~"""
self.check_webhook("commit_comment_added", TOPIC, expected_message)
@@ -40,7 +40,7 @@ class Bitbucket3HookTests(WebhookTestCase):
expected_topic = "sandbox v2"
self.check_webhook("repo_modified", expected_topic, expected_message)
- # Repo Push Events:
+ # Repo push events:
def test_push_add_branch(self) -> None:
expected_message = """[hypro999](http://139.59.64.214:7990/users/hypro999) created branch2 branch."""
expected_topic = TOPIC_BRANCH_EVENTS.format(branch="branch2")
@@ -105,7 +105,7 @@ class Bitbucket3HookTests(WebhookTestCase):
expected_topic = TOPIC_BRANCH_EVENTS.format(branch="branch1")
self.check_webhook("repo_push_update_multiple_branches", expected_topic, expected_message)
- # Core PR Events:
+ # Core PR events:
def test_pr_opened_without_reviewers(self) -> None:
expected_topic = "sandbox / PR #1 Branch1"
expected_message = """[hypro999](http://139.59.64.214:7990/users/hypro999) opened [PR #1](http://139.59.64.214:7990/projects/SBOX/repos/sandbox/pull-requests/1) from `branch1` to `master`:\n\n~~~ quote\n* Add file2.txt\r\n* Add file3.txt\n~~~"""
@@ -175,7 +175,7 @@ class Bitbucket3HookTests(WebhookTestCase):
expected_message = """[zura](http://139.59.64.214:7990/users/zura) merged [PR #6](http://139.59.64.214:7990/projects/SBOX/repos/sandbox/pull-requests/6)."""
self.check_webhook("pull_request_merged", expected_topic, expected_message)
- # PR Reviewer Events:
+ # PR reviewer events:
def test_pr_approved(self) -> None:
expected_topic = "sandbox / PR #6 sample_file: Add sample_file.txt."
expected_message = """[zura](http://139.59.64.214:7990/users/zura) approved [PR #6](http://139.59.64.214:7990/projects/SBOX/repos/sandbox/pull-requests/6)."""
@@ -225,7 +225,7 @@ class Bitbucket3HookTests(WebhookTestCase):
self.url = self.build_webhook_url(topic='custom_topic')
self.check_webhook("pull_request_remove_reviewer", expected_topic, expected_message)
- # PR Comment Events:
+ # PR comment events:
def test_pull_request_comment_added(self) -> None:
expected_message = """[zura](http://139.59.64.214:7990/users/zura) commented on [PR #6](http://139.59.64.214:7990/projects/SBOX/repos/sandbox/pull-requests/6):\n\n~~~ quote\nThis seems like a pretty good idea.\n~~~"""
expected_topic = "sandbox / PR #6 sample_file: Add sample_file.txt."
diff --git a/zerver/webhooks/circleci/view.py b/zerver/webhooks/circleci/view.py
index 268c6bf2d1..74e49a915c 100644
--- a/zerver/webhooks/circleci/view.py
+++ b/zerver/webhooks/circleci/view.py
@@ -49,7 +49,7 @@ def get_commit_range_info(payload: Dict[str, Any]) -> str:
commit_range_url = f"{vcs_url}/compare/{first_commit_id}...{last_commit_id}"
return f"- **Commits ({num_commits}):** [{shortened_first_commit_id} ... {shortened_last_commit_id}]({commit_range_url})"
else:
- # BitBucket doesn't have a good commit range url feature like GitHub does.
+ # Bitbucket doesn't have a good commit range URL feature like GitHub does.
# So let's just show the two separately.
# https://community.atlassian.com/t5/Bitbucket-questions/BitBucket-4-14-diff-between-any-two-commits/qaq-p/632974
first_commit_url = commits[0]["commit_url"]
diff --git a/zerver/webhooks/deskdotcom/tests.py b/zerver/webhooks/deskdotcom/tests.py
index 3bcc603552..b66cddad62 100644
--- a/zerver/webhooks/deskdotcom/tests.py
+++ b/zerver/webhooks/deskdotcom/tests.py
@@ -2,7 +2,7 @@ from zerver.lib.test_classes import WebhookTestCase
# Tests for the Desk.com webhook integration.
#
-# The stream name must be provided in the url-encoded test fixture data,
+# The stream name must be provided in the URL-encoded test fixture data,
# and must match STREAM_NAME set here.
#
# Example:
diff --git a/zerver/webhooks/dialogflow/tests.py b/zerver/webhooks/dialogflow/tests.py
index 74249c8df3..4db4b2564d 100644
--- a/zerver/webhooks/dialogflow/tests.py
+++ b/zerver/webhooks/dialogflow/tests.py
@@ -38,5 +38,5 @@ class DialogflowHookTests(WebhookTestCase):
username="aaron",
user_ip="127.0.0.1",
)
- expected_message = "DialogFlow couldn't process your query."
+ expected_message = "Dialogflow couldn't process your query."
self.send_and_test_private_message("exception", expected_message)
diff --git a/zerver/webhooks/dialogflow/view.py b/zerver/webhooks/dialogflow/view.py
index 8617294bbd..f0380262d7 100644
--- a/zerver/webhooks/dialogflow/view.py
+++ b/zerver/webhooks/dialogflow/view.py
@@ -10,7 +10,7 @@ from zerver.lib.response import json_success
from zerver.models import UserProfile, get_user_profile_by_email
-@webhook_view("dialogflow")
+@webhook_view("Dialogflow")
@has_request_variables
def api_dialogflow_webhook(request: HttpRequest, user_profile: UserProfile,
payload: Dict[str, Any]=REQ(argument_type='body'),
@@ -22,7 +22,7 @@ def api_dialogflow_webhook(request: HttpRequest, user_profile: UserProfile,
if not result:
alternate_result = payload["alternateResult"]["fulfillment"]["speech"]
if not alternate_result:
- body = "DialogFlow couldn't process your query."
+ body = "Dialogflow couldn't process your query."
else:
body = alternate_result
else:
diff --git a/zerver/webhooks/gci/view.py b/zerver/webhooks/gci/view.py
index cba4c9aa25..ab420f95ed 100644
--- a/zerver/webhooks/gci/view.py
+++ b/zerver/webhooks/gci/view.py
@@ -100,7 +100,7 @@ def get_outoftime_event_body(payload: Dict[str, Any]) -> str:
task_url=build_instance_url(payload['task_instance']),
)
-@webhook_view("Google-Code-In")
+@webhook_view("GoogleCodeIn")
@has_request_variables
def api_gci_webhook(request: HttpRequest, user_profile: UserProfile,
payload: Dict[str, Any]=REQ(argument_type='body')) -> HttpResponse:
diff --git a/zerver/webhooks/github/tests.py b/zerver/webhooks/github/tests.py
index 132e6ff507..d7d49c07c8 100644
--- a/zerver/webhooks/github/tests.py
+++ b/zerver/webhooks/github/tests.py
@@ -13,7 +13,7 @@ TOPIC_ORGANIZATION = "baxterandthehackers organization"
TOPIC_BRANCH = "public-repo / changes"
TOPIC_WIKI = "public-repo / Wiki Pages"
-class GithubWebhookTest(WebhookTestCase):
+class GitHubWebhookTest(WebhookTestCase):
STREAM_NAME = 'github'
URL_TEMPLATE = "/api/v1/external/github?stream={stream}&api_key={api_key}"
FIXTURE_DIR_NAME = 'github'
@@ -212,7 +212,7 @@ class GithubWebhookTest(WebhookTestCase):
self.check_webhook("release", TOPIC_REPO, expected_message)
def test_page_build_msg(self) -> None:
- expected_message = "Github Pages build, triggered by baxterthehacker, has finished building."
+ expected_message = "GitHub Pages build, triggered by baxterthehacker, has finished building."
self.check_webhook("page_build", TOPIC_REPO, expected_message)
def test_status_msg(self) -> None:
diff --git a/zerver/webhooks/github/view.py b/zerver/webhooks/github/view.py
index 62664ac7a3..00921f5559 100644
--- a/zerver/webhooks/github/view.py
+++ b/zerver/webhooks/github/view.py
@@ -330,7 +330,7 @@ def get_page_build_body(helper: Helper) -> str:
CONTENT_MESSAGE_TEMPLATE.format(message=build['error']['message']),
)
- return "Github Pages build, triggered by {}, {}.".format(
+ return "GitHub Pages build, triggered by {}, {}.".format(
payload['build']['pusher']['login'],
action,
)
@@ -605,7 +605,7 @@ def api_github_webhook(
branches: Optional[str]=REQ(default=None),
user_specified_topic: Optional[str]=REQ("topic", default=None)) -> HttpResponse:
"""
- Github sends the event as an HTTP header. We have our
+ GitHub sends the event as an HTTP header. We have our
own Zulip-specific concept of an event that often maps
directly to the X_GITHUB_EVENT header's event, but we sometimes
refine it based on the payload.
diff --git a/zerver/webhooks/gitlab/view.py b/zerver/webhooks/gitlab/view.py
index a8ecf57579..0025d56588 100644
--- a/zerver/webhooks/gitlab/view.py
+++ b/zerver/webhooks/gitlab/view.py
@@ -361,7 +361,7 @@ EVENT_FUNCTION_MAPPER = {
'Pipeline Hook': get_pipeline_event_body,
}
-@webhook_view("Gitlab")
+@webhook_view("GitLab")
@has_request_variables
def api_gitlab_webhook(request: HttpRequest, user_profile: UserProfile,
payload: Dict[str, Any]=REQ(argument_type='body'),
@@ -441,7 +441,7 @@ def get_subject_based_on_event(event: str, payload: Dict[str, Any], use_merge_re
def get_event(request: HttpRequest, payload: Dict[str, Any], branches: Optional[str]) -> Optional[str]:
event = validate_extract_webhook_http_header(request, 'X_GITLAB_EVENT', 'GitLab')
if event == "System Hook":
- # Convert the event name to a Gitlab event title
+ # Convert the event name to a GitLab event title
event_name = payload.get('event_name', payload.get('object_kind'))
event = event_name.split("__")[0].replace("_", " ").title()
event = f"{event} Hook"
diff --git a/zerver/webhooks/jira/view.py b/zerver/webhooks/jira/view.py
index d5c660c678..81f6de892d 100644
--- a/zerver/webhooks/jira/view.py
+++ b/zerver/webhooks/jira/view.py
@@ -101,7 +101,7 @@ def get_in(payload: Dict[str, Any], keys: List[str], default: str='') -> Any:
def get_issue_string(payload: Dict[str, Any], issue_id: Optional[str]=None, with_title: bool=False) -> str:
# Guess the URL as it is not specified in the payload
# We assume that there is a /browse/BUG-### page
- # from the REST url of the issue itself
+ # from the REST URL of the issue itself
if issue_id is None:
issue_id = get_issue_id(payload)
diff --git a/zerver/webhooks/opsgenie/tests.py b/zerver/webhooks/opsgenie/tests.py
index 5503355553..4f88b9d086 100644
--- a/zerver/webhooks/opsgenie/tests.py
+++ b/zerver/webhooks/opsgenie/tests.py
@@ -9,7 +9,7 @@ class OpsGenieHookTests(WebhookTestCase):
def test_acknowledge_alert(self) -> None:
expected_topic = "Integration1"
expected_message = """
-[OpsGenie Alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
+[OpsGenie alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
* **Type**: Acknowledge
* **Message**: test alert
* **Tags**: `tag1`, `tag2`
@@ -25,7 +25,7 @@ class OpsGenieHookTests(WebhookTestCase):
def test_addnote_alert(self) -> None:
expected_topic = "Integration1"
expected_message = """
-[OpsGenie Alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
+[OpsGenie alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
* **Type**: AddNote
* **Note**: note to test alert
* **Message**: test alert
@@ -42,7 +42,7 @@ class OpsGenieHookTests(WebhookTestCase):
def test_addrecipient_alert(self) -> None:
expected_topic = "Integration1"
expected_message = """
-[OpsGenie Alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
+[OpsGenie alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
* **Type**: AddRecipient
* **Recipient**: team2_escalation
* **Message**: test alert
@@ -59,7 +59,7 @@ class OpsGenieHookTests(WebhookTestCase):
def test_addtags_alert(self) -> None:
expected_topic = "Integration1"
expected_message = """
-[OpsGenie Alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
+[OpsGenie alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
* **Type**: AddTags
* **Tags added**: tag1,tag2,tag3
* **Message**: test alert
@@ -76,7 +76,7 @@ class OpsGenieHookTests(WebhookTestCase):
def test_addteam_alert(self) -> None:
expected_topic = "Integration1"
expected_message = """
-[OpsGenie Alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
+[OpsGenie alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
* **Type**: AddTeam
* **Team added**: team2
* **Message**: test alert
@@ -93,7 +93,7 @@ class OpsGenieHookTests(WebhookTestCase):
def test_assignownership_alert(self) -> None:
expected_topic = "Integration1"
expected_message = """
-[OpsGenie Alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
+[OpsGenie alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
* **Type**: AssignOwnership
* **Assigned owner**: user2@ifountain.com
* **Message**: test alert
@@ -110,7 +110,7 @@ class OpsGenieHookTests(WebhookTestCase):
def test_close_alert(self) -> None:
expected_topic = "Integration1"
expected_message = """
-[OpsGenie Alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
+[OpsGenie alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
* **Type**: Close
* **Message**: test alert
""".strip()
@@ -125,7 +125,7 @@ class OpsGenieHookTests(WebhookTestCase):
def test_create_alert(self) -> None:
expected_topic = "Webhook"
expected_message = """
-[OpsGenie Alert for Webhook](https://app.opsgenie.com/alert/V2#/show/ec03dad6-62c8-4c94-b38b-d88f398e900f):
+[OpsGenie alert for Webhook](https://app.opsgenie.com/alert/V2#/show/ec03dad6-62c8-4c94-b38b-d88f398e900f):
* **Type**: Create
* **Message**: another alert
* **Tags**: `vip`
@@ -141,7 +141,7 @@ class OpsGenieHookTests(WebhookTestCase):
def test_customaction_alert(self) -> None:
expected_topic = "Integration1"
expected_message = """
-[OpsGenie Alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
+[OpsGenie alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
* **Type**: TestAction
* **Message**: test alert
* **Tags**: `tag1`, `tag2`
@@ -157,7 +157,7 @@ class OpsGenieHookTests(WebhookTestCase):
def test_delete_alert(self) -> None:
expected_topic = "Integration1"
expected_message = """
-[OpsGenie Alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
+[OpsGenie alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
* **Type**: Delete
* **Message**: test alert
""".strip()
@@ -172,7 +172,7 @@ class OpsGenieHookTests(WebhookTestCase):
def test_escalate_alert(self) -> None:
expected_topic = "Webhook_Test"
expected_message = """
-[OpsGenie Alert for Webhook_Test](https://app.opsgenie.com/alert/V2#/show/7ba97e3a-d328-4b5e-8f9a-39e945a3869a):
+[OpsGenie alert for Webhook_Test](https://app.opsgenie.com/alert/V2#/show/7ba97e3a-d328-4b5e-8f9a-39e945a3869a):
* **Type**: Escalate
* **Escalation**: test_esc
""".strip()
@@ -187,7 +187,7 @@ class OpsGenieHookTests(WebhookTestCase):
def test_removetags_alert(self) -> None:
expected_topic = "Integration1"
expected_message = """
-[OpsGenie Alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
+[OpsGenie alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
* **Type**: RemoveTags
* **Tags removed**: tag3
* **Message**: test alert
@@ -204,7 +204,7 @@ class OpsGenieHookTests(WebhookTestCase):
def test_takeownership_alert(self) -> None:
expected_topic = "Webhook"
expected_message = """
-[OpsGenie Alert for Webhook](https://app.opsgenie.com/alert/V2#/show/8a745a79-3ed3-4044-8427-98e067c0623c):
+[OpsGenie alert for Webhook](https://app.opsgenie.com/alert/V2#/show/8a745a79-3ed3-4044-8427-98e067c0623c):
* **Type**: TakeOwnership
* **Message**: message test
* **Tags**: `tag1`, `tag2`
@@ -220,7 +220,7 @@ class OpsGenieHookTests(WebhookTestCase):
def test_unacknowledge_alert(self) -> None:
expected_topic = "Integration1"
expected_message = """
-[OpsGenie Alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
+[OpsGenie alert for Integration1](https://app.opsgenie.com/alert/V2#/show/052652ac-5d1c-464a-812a-7dd18bbfba8c):
* **Type**: UnAcknowledge
* **Message**: test alert
* **Tags**: `tag1`, `tag2`
diff --git a/zerver/webhooks/opsgenie/view.py b/zerver/webhooks/opsgenie/view.py
index 76e1e72dca..acfbde7190 100644
--- a/zerver/webhooks/opsgenie/view.py
+++ b/zerver/webhooks/opsgenie/view.py
@@ -73,7 +73,7 @@ def api_opsgenie_webhook(request: HttpRequest, user_profile: UserProfile,
)
body_template = """
-[OpsGenie Alert for {integration_name}](https://app.opsgenie.com/alert/V2#/show/{alert_id}):
+[OpsGenie alert for {integration_name}](https://app.opsgenie.com/alert/V2#/show/{alert_id}):
* **Type**: {alert_type}
{additional_info}
""".strip()
diff --git a/zerver/webhooks/papertrail/doc.md b/zerver/webhooks/papertrail/doc.md
index 62a5e55d7c..8dee64f8d5 100644
--- a/zerver/webhooks/papertrail/doc.md
+++ b/zerver/webhooks/papertrail/doc.md
@@ -4,7 +4,7 @@ Get Zulip notifications for your Papertrail logs!
1. {!create-bot-construct-url-indented.md!}
-1. On your Papertrail Dashboard, search for the logs you'd like
+1. On your Papertrail dashboard, search for the logs you'd like
to set up alerts for, and click on **Save Search**. Provide a
name for the search, and click **Save & Setup an Alert**.
Under **Create an alert**, click on **Webhook**.
diff --git a/zerver/webhooks/pivotal/view.py b/zerver/webhooks/pivotal/view.py
index 62e0fdde7d..4a336d2360 100644
--- a/zerver/webhooks/pivotal/view.py
+++ b/zerver/webhooks/pivotal/view.py
@@ -31,7 +31,7 @@ def api_pivotal_webhook_v3(request: HttpRequest, user_profile: UserProfile) -> T
description = payload.find('description').text
project_id = payload.find('project_id').text
story_id = get_text(['stories', 'story', 'id'])
- # Ugh, the URL in the XML data is not a clickable url that works for the user
+ # Ugh, the URL in the XML data is not a clickable URL that works for the user
# so we try to build one that the user can actually click on
url = f"https://www.pivotaltracker.com/s/projects/{project_id}/stories/{story_id}"
diff --git a/zerver/webhooks/semaphore/tests.py b/zerver/webhooks/semaphore/tests.py
index 8ea4075b2c..80b491073a 100644
--- a/zerver/webhooks/semaphore/tests.py
+++ b/zerver/webhooks/semaphore/tests.py
@@ -44,7 +44,7 @@ class SemaphoreHookTests(WebhookTestCase):
content_type="application/x-www-form-urlencoded",
)
- # Tests For Semaphore 2.0
+ # Tests for Semaphore 2.0
def test_semaphore2_push(self) -> None:
expected_topic = "notifications/rw/webhook_impl" # repo/branch
diff --git a/zerver/webhooks/solano/view.py b/zerver/webhooks/solano/view.py
index 85c36d863c..6ddb4d2c8a 100644
--- a/zerver/webhooks/solano/view.py
+++ b/zerver/webhooks/solano/view.py
@@ -44,7 +44,7 @@ def api_solano_webhook(request: HttpRequest, user_profile: UserProfile,
elif status in neutral_status:
emoji = ':arrows_counterclockwise:'
- # If the service is not one of the following, the url is of the repository home, not the individual
+ # If the service is not one of the following, the URL is of the repository home, not the individual
# commit itself.
commit_url = repository.split('@')[1]
if 'github' in repository:
diff --git a/zerver/webhooks/wordpress/view.py b/zerver/webhooks/wordpress/view.py
index ae1d16211f..af9eaa19e4 100644
--- a/zerver/webhooks/wordpress/view.py
+++ b/zerver/webhooks/wordpress/view.py
@@ -19,7 +19,7 @@ New blog user registered:
""".strip()
WP_LOGIN_TEMPLATE = 'User {name} logged in.'
-@webhook_view("Wordpress", notify_bot_owner_on_invalid_json=False)
+@webhook_view("WordPress", notify_bot_owner_on_invalid_json=False)
@has_request_variables
def api_wordpress_webhook(request: HttpRequest, user_profile: UserProfile,
hook: str=REQ(default="WordPress Action"),
diff --git a/zerver/webhooks/zabbix/doc.md b/zerver/webhooks/zabbix/doc.md
index ec49bf0af7..8ab3c72ed5 100644
--- a/zerver/webhooks/zabbix/doc.md
+++ b/zerver/webhooks/zabbix/doc.md
@@ -19,7 +19,7 @@ Receive Zabbix notifications in Zulip!
the exact path might differ depending on your environment. Make sure the
script is executable by your Zabbix environment.
-1. Go to your Zabbix Web Interface, and click **Administration**. Click on
+1. Go to your Zabbix web interface, and click **Administration**. Click on
**Media Types**, and click **Create Media Type**.
1. Set **name** to a name of your choice, such as `Zulip`. Set **type** to **Script**,
@@ -31,7 +31,7 @@ Receive Zabbix notifications in Zulip!
Check the **Enabled** option, and click **Update**.
-1. Go back to your Zabbix Web Interface, and click **Administration**. Click
+1. Go back to your Zabbix web interface, and click **Administration**. Click
on **Users**, and select the alias of the user you would like
to use to set the notification. Click **Media**, and click **Add**.
@@ -39,7 +39,7 @@ Receive Zabbix notifications in Zulip!
Tweak the severity for notifications as appropriate, and check the
**Enabled** option.
-1. Go back to your Zabbix Web Interface, and click **Configuration**.
+1. Go back to your Zabbix web interface, and click **Configuration**.
Click **Actions**, and click **Create Action**.
1. Set **Name** to a name of your choice, such as `Zulip`. Under
diff --git a/zilencer/README.md b/zilencer/README.md
index ecd7dc37a0..e1da509a9d 100644
--- a/zilencer/README.md
+++ b/zilencer/README.md
@@ -1,4 +1,4 @@
-ZILENCER -- The Zulip License Manager
+ZILENCER -- The Zulip license manager
========
This app is the place for storing state about various deployments of
diff --git a/zilencer/management/commands/queue_rate.py b/zilencer/management/commands/queue_rate.py
index 2641659b4b..260300f097 100644
--- a/zilencer/management/commands/queue_rate.py
+++ b/zilencer/management/commands/queue_rate.py
@@ -8,7 +8,7 @@ from zerver.worker.queue_processors import BatchNoopWorker, NoopWorker, QueuePro
class Command(BaseCommand):
- help = """Times the overhead of enqueuing and dequeuing messages from rabbitmq."""
+ help = """Times the overhead of enqueuing and dequeuing messages from RabbitMQ."""
def add_arguments(self, parser: CommandParser) -> None:
parser.add_argument(
@@ -22,7 +22,7 @@ class Command(BaseCommand):
)
parser.add_argument(
"--prefetch",
- help="Limits the prefetch size; rabbitmq defaults to unbounded (0)",
+ help="Limits the prefetch size; RabbitMQ defaults to unbounded (0)",
default=0,
type=int,
)
diff --git a/zproject/backends.py b/zproject/backends.py
index fc64d31d36..e78495754a 100644
--- a/zproject/backends.py
+++ b/zproject/backends.py
@@ -333,7 +333,7 @@ def check_password_strength(password: str) -> bool:
class EmailAuthBackend(ZulipAuthMixin):
"""
- Email+Password Authentication Backend (the default).
+ Email+Password authentication backend (the default).
Allows a user to sign in using an email/password pair.
"""
@@ -464,8 +464,8 @@ class ZulipLDAPAuthBackendBase(ZulipAuthMixin, LDAPBackend):
def django_to_ldap_username(self, username: str) -> str:
"""
Translates django username (user_profile.delivery_email or whatever the user typed in the login
- field when authenticating via the ldap backend) into ldap username.
- Guarantees that the username it returns actually has an entry in the ldap directory.
+ field when authenticating via the LDAP backend) into LDAP username.
+ Guarantees that the username it returns actually has an entry in the LDAP directory.
Raises ZulipLDAPExceptionNoMatchingLDAPUser if that's not possible.
"""
result = username
@@ -490,9 +490,9 @@ class ZulipLDAPAuthBackendBase(ZulipAuthMixin, LDAPBackend):
result = username
if _LDAPUser(self, result).attrs is None:
- # Check that there actually is an ldap entry matching the result username
+ # Check that there actually is an LDAP entry matching the result username
# we want to return. Otherwise, raise an exception.
- error_message = "No ldap user matching django_to_ldap_username result: {}. Input username: {}"
+ error_message = "No LDAP user matching django_to_ldap_username result: {}. Input username: {}"
raise ZulipLDAPExceptionNoMatchingLDAPUser(
error_message.format(result, username),
)
@@ -509,7 +509,7 @@ class ZulipLDAPAuthBackendBase(ZulipAuthMixin, LDAPBackend):
return "@".join((username, settings.LDAP_APPEND_DOMAIN))
if settings.LDAP_EMAIL_ATTR is not None:
- # Get email from ldap attributes.
+ # Get email from LDAP attributes.
if settings.LDAP_EMAIL_ATTR not in ldap_user.attrs:
raise ZulipLDAPException(f"LDAP user doesn't have the needed {settings.LDAP_EMAIL_ATTR} attribute")
else:
@@ -690,7 +690,7 @@ class ZulipLDAPAuthBackend(ZulipLDAPAuthBackendBase):
email address for this user obtained from LDAP has an active
account in this Zulip realm. If so, it will log them in.
- Otherwise, to provide a seamless Single Sign-On experience
+ Otherwise, to provide a seamless single sign-on experience
with LDAP, this function can automatically create a new Zulip
user account in the realm (assuming the realm is configured to
allow that email address to sign up).
@@ -767,9 +767,9 @@ class ZulipLDAPUser(_LDAPUser):
"""
This is an extension of the _LDAPUser class, with a realm attribute
attached to it. It's purpose is to call its inherited method
- populate_user() which will sync the ldap data with the corresponding
+ populate_user() which will sync the LDAP data with the corresponding
UserProfile. The realm attribute serves to uniquely identify the UserProfile
- in case the ldap user is registered to multiple realms.
+ in case the LDAP user is registered to multiple realms.
"""
def __init__(self, *args: Any, **kwargs: Any) -> None:
@@ -961,7 +961,7 @@ def external_auth_method(cls: Type[ExternalAuthMethod]) -> Type[ExternalAuthMeth
EXTERNAL_AUTH_METHODS.append(cls)
return cls
-# We want to be able to store this data in redis, so it has to be easy to serialize.
+# We want to be able to store this data in Redis, so it has to be easy to serialize.
# That's why we avoid having fields that could pose a problem for that.
class ExternalAuthDataDict(TypedDict, total=False):
subdomain: str
@@ -1093,8 +1093,8 @@ def redirect_deactivated_user_to_login() -> HttpResponseRedirect:
def social_associate_user_helper(backend: BaseAuth, return_data: Dict[str, Any],
*args: Any, **kwargs: Any) -> Union[HttpResponse, Optional[UserProfile]]:
- """Responsible for doing the Zulip-account lookup and validation parts
- of the Zulip Social auth pipeline (similar to the authenticate()
+ """Responsible for doing the Zulip account lookup and validation parts
+ of the Zulip social auth pipeline (similar to the authenticate()
methods in most other auth backends in this file).
Returns a UserProfile object for successful authentication, and None otherwise.
@@ -1586,7 +1586,7 @@ class AppleAuthBackend(SocialAuthMixin, AppleIdAuth):
return self.strategy.request_data().get('native_flow', False)
# This method replaces a method from python-social-auth; it is adapted to store
- # the state_token data in redis.
+ # the state_token data in Redis.
def get_or_create_state(self) -> str:
'''Creates the Oauth2 state parameter in first step of the flow,
before redirecting the user to the IdP (aka Apple).
@@ -1600,10 +1600,10 @@ class AppleAuthBackend(SocialAuthMixin, AppleIdAuth):
POST request coming from Apple.
To work around this, we replace python-social-auth's default
- session-based storage with storing the parameters in redis
+ session-based storage with storing the parameters in Redis
under a random token derived from the state. That will allow
us to validate the state and retrieve the params after the
- redirect - by querying redis for the key derived from the
+ redirect - by querying Redis for the key derived from the
state sent in the POST redirect.
'''
request_data = self.strategy.request_data().dict()
@@ -1622,7 +1622,7 @@ class AppleAuthBackend(SocialAuthMixin, AppleIdAuth):
def validate_state(self) -> Optional[str]:
"""
This method replaces a method from python-social-auth; it is
- adapted to retrieve the data stored in redis, save it in
+ adapted to retrieve the data stored in Redis, save it in
the session so that it can be accessed by the social pipeline.
"""
request_state = self.get_request_state()
@@ -1772,7 +1772,7 @@ class SAMLAuthBackend(SocialAuthMixin, SAMLAuth):
#
# To protect against network eavesdropping of these
# parameters, we send just a random token to the IdP in
- # RelayState, which is used as a key into our redis data store
+ # RelayState, which is used as a key into our Redis data store
# for fetching the actual parameters after the IdP has
# returned a successful authentication.
params_to_relay = self.standard_relay_params
@@ -1794,7 +1794,7 @@ class SAMLAuthBackend(SocialAuthMixin, SAMLAuth):
def get_data_from_redis(cls, key: str) -> Optional[Dict[str, Any]]:
data = None
if key.startswith('saml_token_'):
- # Safety if statement, to not allow someone to poke around arbitrary redis keys here.
+ # Safety if statement, to not allow someone to poke around arbitrary Redis keys here.
data = get_dict_from_redis(redis_client, "saml_token_{token}", key)
return data
diff --git a/zproject/computed_settings.py b/zproject/computed_settings.py
index 83d5066141..6a9bc195ed 100644
--- a/zproject/computed_settings.py
+++ b/zproject/computed_settings.py
@@ -193,7 +193,7 @@ MIDDLEWARE = (
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
# Make sure 2FA middlewares come after authentication middleware.
- 'django_otp.middleware.OTPMiddleware', # Required by Two Factor auth.
+ 'django_otp.middleware.OTPMiddleware', # Required by two factor auth.
'two_factor.middleware.threadlocals.ThreadLocals', # Required by Twilio
# Needs to be after CommonMiddleware, which sets Content-Length
'zerver.middleware.FinalizeOpenGraphDescription',
@@ -255,7 +255,7 @@ SILENCED_SYSTEM_CHECKS = [
########################################################################
# Zulip's Django configuration supports 4 different ways to do
-# postgres authentication:
+# Postgres authentication:
#
# * The development environment uses the `local_database_password`
# secret from `zulip-secrets.conf` to authenticate with a local
@@ -264,18 +264,18 @@ SILENCED_SYSTEM_CHECKS = [
#
# The remaining 3 options are for production use:
#
-# * Using postgres' "peer" authentication to authenticate to a
+# * Using Postgres' "peer" authentication to authenticate to a
# database on the local system using one's user ID (processes
# running as user `zulip` on the system are automatically
# authenticated as database user `zulip`). This is the default in
# production. We don't use this in the development environment,
# because it requires the developer's user to be called `zulip`.
#
-# * Using password authentication with a remote postgres server using
+# * Using password authentication with a remote Postgres server using
# the `REMOTE_POSTGRES_HOST` setting and the password from the
# `postgres_password` secret.
#
-# * Using passwordless authentication with a remote postgres server
+# * Using passwordless authentication with a remote Postgres server
# using the `REMOTE_POSTGRES_HOST` setting and a client certificate
# under `/home/zulip/.postgresql/`.
#
@@ -411,7 +411,7 @@ if PRODUCTION:
SESSION_COOKIE_NAME = "__Host-sessionid"
CSRF_COOKIE_NAME = "__Host-csrftoken"
-# Prevent Javascript from reading the CSRF token from cookies. Our code gets
+# Prevent JavaScript from reading the CSRF token from cookies. Our code gets
# the token from the DOM, which means malicious code could too. But hiding the
# cookie will slow down some attackers.
CSRF_COOKIE_HTTPONLY = True
@@ -1056,7 +1056,7 @@ SOCIAL_AUTH_GITHUB_TEAM_SECRET = SOCIAL_AUTH_GITHUB_SECRET
SOCIAL_AUTH_GOOGLE_SECRET = get_secret('social_auth_google_secret')
# Fallback to google-oauth settings in case social auth settings for
-# google are missing; this is for backwards-compatibility with older
+# Google are missing; this is for backwards-compatibility with older
# Zulip versions where /etc/zulip/settings.py has not been migrated yet.
GOOGLE_OAUTH2_CLIENT_SECRET = get_secret('google_oauth2_client_secret')
SOCIAL_AUTH_GOOGLE_KEY = SOCIAL_AUTH_GOOGLE_KEY or GOOGLE_OAUTH2_CLIENT_ID
diff --git a/zproject/default_settings.py b/zproject/default_settings.py
index 856e5d621d..16c6ac37e9 100644
--- a/zproject/default_settings.py
+++ b/zproject/default_settings.py
@@ -173,7 +173,7 @@ RATE_LIMITING_AUTHENTICATE = True
SEND_LOGIN_EMAILS = True
EMBEDDED_BOTS_ENABLED = False
-# Two Factor Authentication is not yet implementation-complete
+# Two factor authentication is not yet implementation-complete
TWO_FACTOR_AUTHENTICATION_ENABLED = False
# This is used to send all hotspots for convenient manual testing
@@ -252,7 +252,7 @@ REALM_HOSTS: Dict[str, str] = {}
# mean that a different hostname must be used for mobile access.
REALM_MOBILE_REMAP_URIS: Dict[str, str] = {}
-# Whether the server is using the Pgroonga full-text search
+# Whether the server is using the PGroonga full-text search
# backend. Plan is to turn this on for everyone after further
# testing.
USING_PGROONGA = False
diff --git a/zproject/dev_settings.py b/zproject/dev_settings.py
index 631615024d..2478094d8b 100644
--- a/zproject/dev_settings.py
+++ b/zproject/dev_settings.py
@@ -167,7 +167,7 @@ SEARCH_PILLS_ENABLED = bool(os.getenv('SEARCH_PILLS_ENABLED', False))
BILLING_ENABLED = True
LANDING_PAGE_NAVBAR_MESSAGE = None
-# Test Custom TOS template rendering
+# Test custom TOS template rendering
TERMS_OF_SERVICE = 'corporate/terms.md'
# Our run-dev.py proxy uses X-Forwarded-Port to communicate to Django
diff --git a/zproject/legacy_urls.py b/zproject/legacy_urls.py
index 1366f13be0..1ad5f18b83 100644
--- a/zproject/legacy_urls.py
+++ b/zproject/legacy_urls.py
@@ -6,7 +6,7 @@ import zerver.views.report
import zerver.views.streams
import zerver.views.tutorial
-# Future endpoints should add to urls.py, which includes these legacy urls
+# Future endpoints should add to urls.py, which includes these legacy URLs
legacy_urls = [
# These are json format views used by the web client. They require a logged in browser.
diff --git a/zproject/prod_settings_template.py b/zproject/prod_settings_template.py
index 422255abad..0abc61992d 100644
--- a/zproject/prod_settings_template.py
+++ b/zproject/prod_settings_template.py
@@ -434,7 +434,7 @@ ENABLE_GRAVATAR = True
# and uncomment the following line.
#DEFAULT_AVATAR_URI = '/local-static/default-avatar.png'
-# To access an external postgres database you should define the host name in
+# To access an external Postgres database you should define the host name in
# REMOTE_POSTGRES_HOST, port in REMOTE_POSTGRES_PORT, password in the secrets file in the
# property postgres_password, and the SSL connection mode in REMOTE_POSTGRES_SSLMODE
# Valid values for REMOTE_POSTGRES_SSLMODE are documented in the
@@ -471,7 +471,7 @@ ENABLE_GRAVATAR = True
################
# Email gateway integration.
#
-# The Email gateway integration supports sending messages into Zulip
+# The email gateway integration supports sending messages into Zulip
# by sending an email.
# For details, see the documentation:
# https://zulip.readthedocs.io/en/latest/production/settings.html#email-gateway
@@ -599,11 +599,11 @@ CAMO_URI = '/external_content/'
# RabbitMQ configuration
#
-# By default, Zulip connects to rabbitmq running locally on the machine,
+# By default, Zulip connects to RabbitMQ running locally on the machine,
# but Zulip also supports connecting to RabbitMQ over the network;
# to use a remote RabbitMQ instance, set RABBITMQ_HOST to the hostname here.
# RABBITMQ_HOST = "127.0.0.1"
-# To use another rabbitmq user than the default 'zulip', set RABBITMQ_USERNAME here.
+# To use another RabbitMQ user than the default 'zulip', set RABBITMQ_USERNAME here.
# RABBITMQ_USERNAME = 'zulip'
# Memcached configuration
@@ -619,14 +619,14 @@ CAMO_URI = '/external_content/'
# Redis configuration
#
-# By default, Zulip connects to redis running locally on the machine,
-# but Zulip also supports connecting to redis over the network;
+# By default, Zulip connects to Redis running locally on the machine,
+# but Zulip also supports connecting to Redis over the network;
# to use a remote Redis instance, set REDIS_HOST here.
# REDIS_HOST = '127.0.0.1'
-# For a different redis port set the REDIS_PORT here.
+# For a different Redis port set the REDIS_PORT here.
# REDIS_PORT = 6379
# If you set redis_password in zulip-secrets.conf, Zulip will use that password
-# to connect to the redis server.
+# to connect to the Redis server.
# Controls whether Zulip will rate-limit user requests.
# RATE_LIMITING = True
diff --git a/zproject/test_extra_settings.py b/zproject/test_extra_settings.py
index f4c89cb248..647734a5c7 100644
--- a/zproject/test_extra_settings.py
+++ b/zproject/test_extra_settings.py
@@ -87,7 +87,7 @@ AUTH_LDAP_REVERSE_EMAIL_SEARCH = LDAPSearch("ou=users,dc=zulip,dc=com",
TEST_SUITE = True
RATE_LIMITING = False
RATE_LIMITING_AUTHENTICATE = False
-# Don't use rabbitmq from the test suite -- the user_profile_ids for
+# Don't use RabbitMQ from the test suite -- the user_profile_ids for
# any generated queue elements won't match those being used by the
# real app.
USING_RABBITMQ = False
diff --git a/zproject/urls.py b/zproject/urls.py
index 732321e126..eccf5dda8b 100644
--- a/zproject/urls.py
+++ b/zproject/urls.py
@@ -511,7 +511,7 @@ v1_api_and_json_patterns = [
rest_path('streams',
GET=get_streams_backend),
- # GET returns `stream_id`, stream name should be encoded in the url query (in `stream` param)
+ # GET returns `stream_id`, stream name should be encoded in the URL query (in `stream` param)
rest_path('get_stream_id',
GET=json_get_stream_id),
@@ -591,7 +591,7 @@ v1_api_and_json_patterns = [
integrations_view = IntegrationView.as_view()
# These views serve pages (HTML). As such, their internationalization
-# must depend on the url.
+# must depend on the URL.
#
# If you're adding a new page to the website (as opposed to a new
# endpoint for use by code), you should add it here.
@@ -685,12 +685,12 @@ i18n_urls = [
# Go to organization subdomain
path('accounts/go/', realm_redirect, name='realm_redirect'),
- # Realm Creation
+ # Realm creation
path('new/', create_realm),
path('new/',
create_realm, name='create_realm'),
- # Realm Reactivation
+ # Realm reactivation
path('reactivate/', realm_reactivation,
name='realm_reactivation'),
@@ -759,7 +759,7 @@ urls += [
# user_uploads -> zerver.views.upload.serve_file_backend
#
-# This url is an exception to the url naming schemes for endpoints. It
+# This URL is an exception to the URL naming schemes for endpoints. It
# supports both API and session cookie authentication, using a single
# URL for both (not 'api/v1/' or 'json/' prefix). This is required to
# easily support the mobile apps fetching uploaded files without
@@ -788,13 +788,13 @@ urls += [
{'override_api_url_scheme'})),
]
-# This url serves as a way to receive CSP violation reports from the users.
+# This URL serves as a way to receive CSP violation reports from the users.
# We use this endpoint to just log these reports.
urls += [
path('report/csp_violations', report_csp_violations),
]
-# This url serves as a way to provide backward compatibility to messages
+# This URL serves as a way to provide backward compatibility to messages
# rendered at the time Zulip used camo for doing http -> https conversion for
# such links with images previews. Now thumbor can be used for serving such
# images.
@@ -804,7 +804,7 @@ urls += [
]
# Incoming webhook URLs
-# We don't create urls for particular git integrations here
+# We don't create URLs for particular Git integrations here
# because of generic one below
for incoming_webhook in WEBHOOK_INTEGRATIONS:
if incoming_webhook.url_object:
@@ -890,7 +890,7 @@ urls += [
path('api/', api_documentation_view),
]
-# Two Factor urls
+# Two-factor URLs
if settings.TWO_FACTOR_AUTHENTICATION_ENABLED:
urls += [path('', include(tf_urls)),
path('', include(tf_twilio_urls))]
@@ -899,7 +899,7 @@ if settings.DEVELOPMENT:
urls += dev_urls.urls
i18n_urls += dev_urls.i18n_urls
-# The sequence is important; if i18n urls don't come first then
-# reverse url mapping points to i18n urls which causes the frontend
+# The sequence is important; if i18n URLs don't come first then
+# reverse URL mapping points to i18n URLs which causes the frontend
# tests to fail
urlpatterns = i18n_patterns(*i18n_urls) + urls + legacy_urls
@Outgoing Webhook Test Zulip is the world\u2019s most productive group chat!
", + "rendered_content": "@Outgoing webhook test Zulip is the world\u2019s most productive group chat!
", "sender_id": 5, "stream_id": 5, - "content": "@**Outgoing Webhook Test** Zulip is the world\u2019s most productive group chat!", + "content": "@**Outgoing webhook test** Zulip is the world\u2019s most productive group chat!", "display_recipient": "Verona", "type": "stream", "id": 112, @@ -8645,7 +8645,7 @@ paths: tags: ["streams"] operationId: create_big_blue_button_video_call description: | - Create a video call url for a Big Blue Button video call. + Create a video call URL for a Big Blue Button video call. Requires Big Blue Button to be configured on the Zulip server. responses: "200": @@ -8661,7 +8661,7 @@ paths: msg: {} url: description: | - The url for the Big Blue Button video call. + The URL for the Big Blue Button video call. type: string example: "/calls/bbb/join?meeting_id=%22zulip-something%22&password=%22something%22&checksum=%22somechecksum%22" example: @@ -8936,7 +8936,7 @@ components: base_url: type: string description: | - The url the outgoing webhook is configured to post to. + The URL the outgoing webhook is configured to post to. token: type: string description: | @@ -9160,7 +9160,7 @@ components: type: string nullable: true description: | - The url of the export. Null if there's no url. + The URL of the export. `null` if there's no URL. pending: type: boolean description: | @@ -9450,7 +9450,7 @@ components: within the namespace of the `reaction_type`. For example, for `unicode_emoji`, this will be an encoding of the - unicode codepoint. + Unicode codepoint. emoji_name: type: string description: | @@ -9460,7 +9460,7 @@ components: description: | One of the following values: - * `unicode_emoji`: Unicode emoji (`emoji_code` will be its unicode + * `unicode_emoji`: Unicode emoji (`emoji_code` will be its Unicode codepoint). * `realm_emoji`: [Custom emoji](/help/add-custom-emoji). (`emoji_code` will be its ID). @@ -10324,7 +10324,7 @@ components: from the streams specified in the `subscriptions` parameter. If not provided, then the requesting user/bot is subscribed. - **Changes**: The integer format is new in Zulip 3.0 (Feature level 9). + **Changes**: The integer format is new in Zulip 3.0 (feature level 9). content: application/json: schema: @@ -10342,7 +10342,7 @@ components: it should pass this parameter using the value the server provided for the existing reaction for specificity. Supported values: - * `unicode_emoji`: Unicode emoji (`emoji_code` will be its unicode codepoint). + * `unicode_emoji`: Unicode emoji (`emoji_code` will be its Unicode codepoint). * `realm_emoji`: Custom emoji. (`emoji_code` will be its ID). * `zulip_extra_emoji`: Special emoji included with Zulip. Exists to namespace the `zulip` emoji. diff --git a/zerver/tests/fixtures/markdown_test_cases.json b/zerver/tests/fixtures/markdown_test_cases.json index 5dd482675a..6fb15c0d4c 100644 --- a/zerver/tests/fixtures/markdown_test_cases.json +++ b/zerver/tests/fixtures/markdown_test_cases.json @@ -427,10 +427,10 @@ }, { "name": "only_named_inline_image", - "input": "[Google Link](https://www.google.com/images/srpr/logo4w.png)", - "expected_output": "\n![](\"https://www.google.com/images/srpr/logo4w.png\")
Test: https://developer.github.com/assets/images/hero-circuit-bg.png
\n
\n
Check out this Pycon Video
\n\n
Check out this PyCon video
\ndiscuss lunch after lunch
') - # Test searching in messages with unicode characters + # Test searching in messages with Unicode characters narrow = [ dict(operator='search', operand='日本'), ] @@ -1910,7 +1910,7 @@ class GetOldMessagesTest(ZulipTestCase): english_message['match_content'], 'I want to go to 日本!
') - # Multiple search operands with unicode + # Multiple search operands with Unicode multi_search_narrow = [ dict(operator='search', operand='ちは'), dict(operator='search', operand='今日は'), @@ -2052,7 +2052,7 @@ class GetOldMessagesTest(ZulipTestCase): self.assertEqual(multi_search_result['messages'][0]['match_content'], 'Can you speak https://en.wikipedia.org/wiki/Japanese?
') - # Multiple search operands with unicode + # Multiple search operands with Unicode multi_search_narrow = [ dict(operator='search', operand='朝は'), dict(operator='search', operand='べました'), @@ -2078,7 +2078,7 @@ class GetOldMessagesTest(ZulipTestCase): self.assertEqual(link_search_result['messages'][0]['match_content'], '') - # Search operands with HTML Special Characters + # Search operands with HTML special characters special_search_narrow = [ dict(operator='search', operand='butter'), ] @@ -2522,7 +2522,7 @@ class GetOldMessagesTest(ZulipTestCase): self.exercise_bad_narrow_operand_using_dict_api('search', [''], error_msg) # The exercise_bad_narrow_operand helper method uses legacy tuple format to - # test bad narrow, this method uses the current dict api format + # test bad narrow, this method uses the current dict API format def exercise_bad_narrow_operand_using_dict_api(self, operator: str, operands: Sequence[Any], error_msg: str) -> None: @@ -3236,7 +3236,7 @@ class MessageHasKeywordsTest(ZulipTestCase): msg_contents = ["Link: foo.org", "Image: https://www.google.com/images/srpr/logo4w.png", "Image: https://www.google.com/images/srpr/logo4w.pdf", - "[Google Link](https://www.google.com/images/srpr/logo4w.png)"] + "[Google link](https://www.google.com/images/srpr/logo4w.png)"] for msg_content in msg_contents: msg_ids.append(self.send_stream_message(self.example_user('hamlet'), 'Denmark', content=msg_content)) @@ -3245,7 +3245,7 @@ class MessageHasKeywordsTest(ZulipTestCase): self.update_message(msgs[0], 'https://www.google.com/images/srpr/logo4w.png') self.assertTrue(msgs[0].has_image) - self.update_message(msgs[0], 'No Image Again') + self.update_message(msgs[0], 'No image again') self.assertFalse(msgs[0].has_image) def test_has_attachment(self) -> None: @@ -3259,7 +3259,7 @@ class MessageHasKeywordsTest(ZulipTestCase): msg_id = self.send_stream_message(hamlet, "Denmark", body, "test") msg = Message.objects.get(id=msg_id) self.assertTrue(msg.has_attachment) - self.update_message(msg, 'No Attachments') + self.update_message(msg, 'No attachments') self.assertFalse(msg.has_attachment) self.update_message(msg, body) self.assertTrue(msg.has_attachment) diff --git a/zerver/tests/test_middleware.py b/zerver/tests/test_middleware.py index 10fc5ce693..a0e5895d15 100644 --- a/zerver/tests/test_middleware.py +++ b/zerver/tests/test_middleware.py @@ -105,7 +105,7 @@ class OpenGraphTest(ZulipTestCase): self.check_title_and_description( '/api/', - "Zulip API Documentation", + "Zulip API documentation", [("Zulip's APIs allow you to integrate other services with Zulip. This " "guide should help you find the API you need:")], []) diff --git a/zerver/tests/test_openapi.py b/zerver/tests/test_openapi.py index 3c56d47658..b0d6f4a562 100644 --- a/zerver/tests/test_openapi.py +++ b/zerver/tests/test_openapi.py @@ -327,14 +327,14 @@ class OpenAPIArgumentsTest(ZulipTestCase): if not msg: # nocoverage msg = f""" We found some OpenAPI documentation for {method} {url_pattern}, -so maybe we shouldn't mark it as intentionally undocumented in the urls. +so maybe we shouldn't mark it as intentionally undocumented in the URLs. """ raise AssertionError(msg) # nocoverage except KeyError: return def check_for_non_existant_openapi_endpoints(self) -> None: - """ Here, we check to see if every endpoint documented in the openapi + """ Here, we check to see if every endpoint documented in the OpenAPI documentation actually exists in urls.py and thus in actual code. Note: We define this as a helper called at the end of test_openapi_arguments instead of as a separate test to ensure that @@ -500,7 +500,7 @@ do not match the types declared in the implementation of {function.__name__}.\n" # validator in these cases, but it does happen. # # If the REQ type is not string then, insert the - # REQ and OPENAPI data types of the variable in + # REQ and OpenAPI data types of the variable in # the respective sets so that they can be dealt # with later. In either case remove the variable # from `json_params`. @@ -536,7 +536,7 @@ do not match the types declared in the implementation of {function.__name__}.\n" has_request_variables decorator). At the end, we perform a reverse mapping test that verifies that - every url pattern defined in the openapi documentation actually exists + every URL pattern defined in the OpenAPI documentation actually exists in code. """ diff --git a/zerver/tests/test_push_notifications.py b/zerver/tests/test_push_notifications.py index df7878d475..dcd92139d3 100644 --- a/zerver/tests/test_push_notifications.py +++ b/zerver/tests/test_push_notifications.py @@ -1092,7 +1092,7 @@ class HandlePushNotificationTest(PushNotificationTest): with self.assertLogs(logger_string, level='INFO') as info_logs: do_soft_deactivate_users([self.user_profile]) self.assertEqual(info_logs.output, [ - f"INFO:{logger_string}:Soft Deactivated user {self.user_profile.id}", + f"INFO:{logger_string}:Soft deactivated user {self.user_profile.id}", f"INFO:{logger_string}:Soft-deactivated batch of 1 users; 0 remain to process" ]) sender = self.example_user('iago') diff --git a/zerver/tests/test_rate_limiter.py b/zerver/tests/test_rate_limiter.py index 7cc6fa71fc..d0c23be25d 100644 --- a/zerver/tests/test_rate_limiter.py +++ b/zerver/tests/test_rate_limiter.py @@ -156,7 +156,7 @@ class RedisRateLimiterBackendTest(RateLimiterBackendBase): """ This test cannot verify that the user will get unblocked after the correct amount of time, because that event happens - inside redis, so we're not able to mock the timer. Making the test + inside Redis, so we're not able to mock the timer. Making the test sleep for 1s is also too costly to be worth it. """ obj = self.create_object('test', [(2, 5)]) diff --git a/zerver/tests/test_reactions.py b/zerver/tests/test_reactions.py index e747423b6f..7b13a44ea7 100644 --- a/zerver/tests/test_reactions.py +++ b/zerver/tests/test_reactions.py @@ -205,12 +205,12 @@ class ReactionEmojiTest(ZulipTestCase): self.assertEqual(emoji_code, 'zulip') self.assertEqual(reaction_type, 'zulip_extra_emoji') - # Test unicode emoji. + # Test Unicode emoji. emoji_code, reaction_type = emoji_name_to_emoji_code(realm, 'astonished') self.assertEqual(emoji_code, '1f632') self.assertEqual(reaction_type, 'unicode_emoji') - # Test override unicode emoji. + # Test override Unicode emoji. overriding_emoji = RealmEmoji.objects.create( name='astonished', realm=realm, file_name='astonished') emoji_code, reaction_type = emoji_name_to_emoji_code(realm, 'astonished') diff --git a/zerver/tests/test_settings.py b/zerver/tests/test_settings.py index 64e85f7f97..ebfc1e947c 100644 --- a/zerver/tests/test_settings.py +++ b/zerver/tests/test_settings.py @@ -282,7 +282,7 @@ class ChangeSettingsTest(ZulipTestCase): result = self.client_patch( "/json/settings", dict( - old_password=self.ldap_password("hamlet"), # hamlet's password in ldap + old_password=self.ldap_password("hamlet"), # hamlet's password in LDAP new_password="ignored", )) self.assert_json_error(result, "Your Zulip password is managed in LDAP") diff --git a/zerver/tests/test_signup.py b/zerver/tests/test_signup.py index d276b89847..64ed4fe0e7 100644 --- a/zerver/tests/test_signup.py +++ b/zerver/tests/test_signup.py @@ -510,7 +510,7 @@ class PasswordResetTest(ZulipTestCase): 'zproject.backends.EmailAuthBackend', 'zproject.backends.ZulipDummyBackend')) def test_ldap_and_email_auth(self) -> None: - """If both email and ldap auth backends are enabled, limit password + """If both email and LDAP auth backends are enabled, limit password reset to users outside the LDAP domain""" # If the domain matches, we don't generate an email with self.settings(LDAP_APPEND_DOMAIN="zulip.com"): @@ -1524,7 +1524,7 @@ so we didn't send them an invitation. We did send invitations to everyone else!" self.assertEqual(ScheduledEmail.objects.filter(type=ScheduledEmail.INVITATION_REMINDER).count(), 1) # make sure users can't take a valid confirmation key from another - # pathway and use it with the invitation url route + # pathway and use it with the invitation URL route def test_confirmation_key_of_wrong_type(self) -> None: email = self.nonreg_email("alice") realm = get_realm('zulip') @@ -3613,15 +3613,15 @@ class UserSignUpTest(InviteUserBase): HTTP_HOST=subdomain + ".testserver") self.assertEqual(result.status_code, 302) # We get redirected back to the login page because emails matching LDAP_APPEND_DOMAIN, - # aren't allowed to create non-ldap accounts. + # aren't allowed to create non-LDAP accounts. self.assertEqual(result.url, "/accounts/login/?email=newuser%40zulip.com") self.assertFalse(UserProfile.objects.filter(delivery_email=email).exists()) self.assertEqual(debug_log.output, [ - 'DEBUG:zulip.ldap:ZulipLDAPAuthBackend: No ldap user matching django_to_ldap_username result: newuser. Input username: newuser@zulip.com' + 'DEBUG:zulip.ldap:ZulipLDAPAuthBackend: No LDAP user matching django_to_ldap_username result: newuser. Input username: newuser@zulip.com' ]) - # If the email is outside of LDAP_APPEND_DOMAIN, we successfully create a non-ldap account, - # with the password managed in the zulip database. + # If the email is outside of LDAP_APPEND_DOMAIN, we successfully create a non-LDAP account, + # with the password managed in the Zulip database. with self.settings( POPULATE_PROFILE_VIA_LDAP=True, LDAP_APPEND_DOMAIN='example.com', @@ -3739,7 +3739,7 @@ class UserSignUpTest(InviteUserBase): # Pass HTTP_HOST for the target subdomain HTTP_HOST=subdomain + ".testserver") self.assertEqual(debug_log.output, [ - 'DEBUG:zulip.ldap:ZulipLDAPAuthBackend: No ldap user matching django_to_ldap_username result: nonexistent@zulip.com. Input username: nonexistent@zulip.com' + 'DEBUG:zulip.ldap:ZulipLDAPAuthBackend: No LDAP user matching django_to_ldap_username result: nonexistent@zulip.com. Input username: nonexistent@zulip.com' ]) self.assertEqual(result.status_code, 302) self.assertEqual(result.url, "http://zulip.testserver/") @@ -3764,7 +3764,7 @@ class UserSignUpTest(InviteUserBase): # Invite user. self.login('iago') self.assertEqual(debug_log.output, [ - 'DEBUG:zulip.ldap:ZulipLDAPAuthBackend: No ldap user matching django_to_ldap_username result: iago. Input username: iago@zulip.com' + 'DEBUG:zulip.ldap:ZulipLDAPAuthBackend: No LDAP user matching django_to_ldap_username result: iago. Input username: iago@zulip.com' ]) response = self.invite(invitee_emails='newuser@zulip.com', stream_names=streams, diff --git a/zerver/tests/test_slack_importer.py b/zerver/tests/test_slack_importer.py index 155c32b08c..e74723c05d 100644 --- a/zerver/tests/test_slack_importer.py +++ b/zerver/tests/test_slack_importer.py @@ -309,7 +309,7 @@ class SlackImporter(ZulipTestCase): cpf_name.remove('phone') cpf_name.remove('skype') for name in cpf_name: - self.assertTrue(name.startswith('slack custom field ')) + self.assertTrue(name.startswith('Slack custom field ')) self.assertEqual(len(customprofilefield_value), 6) self.assertEqual(customprofilefield_value[0]['field'], 0) @@ -460,7 +460,7 @@ class SlackImporter(ZulipTestCase): self.assertDictEqual(test_added_mpims, added_mpims) self.assertDictEqual(test_dm_members, dm_members) - # We can't do an assertDictEqual since during the construction of Personal + # We can't do an assertDictEqual since during the construction of personal # recipients, slack_user_id_to_zulip_user_id are iterated in different order in Python 3.5 and 3.6. self.assertEqual(set(slack_recipient_name_to_zulip_recipient_id.keys()), slack_recipient_names) self.assertEqual(set(slack_recipient_name_to_zulip_recipient_id.values()), set(range(11))) @@ -654,10 +654,10 @@ class SlackImporter(ZulipTestCase): self.assertEqual(zerver_message[5]['has_link'], False) self.assertEqual(zerver_message[7]['has_link'], False) - self.assertEqual(zerver_message[3][EXPORT_TOPIC_NAME], 'imported from slack') + self.assertEqual(zerver_message[3][EXPORT_TOPIC_NAME], 'imported from Slack') self.assertEqual(zerver_message[3]['content'], '/me added bot') self.assertEqual(zerver_message[4]['recipient'], slack_recipient_name_to_zulip_recipient_id['general']) - self.assertEqual(zerver_message[2][EXPORT_TOPIC_NAME], 'imported from slack') + self.assertEqual(zerver_message[2][EXPORT_TOPIC_NAME], 'imported from Slack') self.assertEqual(zerver_message[1]['recipient'], slack_recipient_name_to_zulip_recipient_id['random']) self.assertEqual(zerver_message[5]['recipient'], slack_recipient_name_to_zulip_recipient_id['mpdm-user9--user2--user10-1']) self.assertEqual(zerver_message[6]['recipient'], slack_recipient_name_to_zulip_recipient_id['mpdm-user6--user7--user4-1']) diff --git a/zerver/tests/test_soft_deactivation.py b/zerver/tests/test_soft_deactivation.py index 88fb38afa1..2be89c902f 100644 --- a/zerver/tests/test_soft_deactivation.py +++ b/zerver/tests/test_soft_deactivation.py @@ -43,7 +43,7 @@ class UserSoftDeactivationTests(ZulipTestCase): with self.assertLogs(logger_string, level="INFO") as m: do_soft_deactivate_user(user) - self.assertEqual(m.output, [f"INFO:{logger_string}:Soft Deactivated user {user.id}"]) + self.assertEqual(m.output, [f"INFO:{logger_string}:Soft deactivated user {user.id}"]) user.refresh_from_db() self.assertTrue(user.long_term_idle) @@ -66,7 +66,7 @@ class UserSoftDeactivationTests(ZulipTestCase): log_output = [] for user in users: - log_output.append(f"INFO:{logger_string}:Soft Deactivated user {user.id}") + log_output.append(f"INFO:{logger_string}:Soft deactivated user {user.id}") log_output.append(f"INFO:{logger_string}:Soft-deactivated batch of {len(users[:100])} users; {len(users[100:])} remain to process") self.assertEqual(m.output, log_output) @@ -119,7 +119,7 @@ class UserSoftDeactivationTests(ZulipTestCase): log_output = [] for user in users: - log_output.append(f"INFO:{logger_string}:Soft Deactivated user {user.id}") + log_output.append(f"INFO:{logger_string}:Soft deactivated user {user.id}") log_output.append(f"INFO:{logger_string}:Soft-deactivated batch of {len(users[:100])} users; {len(users[100:])} remain to process") self.assertEqual(m.output, log_output) @@ -179,7 +179,7 @@ class UserSoftDeactivationTests(ZulipTestCase): log_output = [] for user in users: - log_output.append(f"INFO:{logger_string}:Soft Deactivated user {user.id}") + log_output.append(f"INFO:{logger_string}:Soft deactivated user {user.id}") log_output.append(f"INFO:{logger_string}:Soft-deactivated batch of {len(users[:100])} users; {len(users[100:])} remain to process") self.assertEqual(m.output, log_output) @@ -237,7 +237,7 @@ class UserSoftDeactivationTests(ZulipTestCase): log_output = [] for user in users: - log_output.append(f"INFO:{logger_string}:Soft Deactivated user {user.id}") + log_output.append(f"INFO:{logger_string}:Soft deactivated user {user.id}") log_output.append(f"INFO:{logger_string}:Soft-deactivated batch of {len(users[:100])} users; {len(users[100:])} remain to process") log_output.append(f"INFO:{logger_string}:Caught up {len(users)} soft-deactivated users") self.assertEqual(set(m.output), set(log_output)) @@ -307,7 +307,7 @@ class SoftDeactivationMessageTest(ZulipTestCase): with self.assertLogs(logger_string, level='INFO') as info_logs: do_soft_deactivate_users([long_term_idle_user]) self.assertEqual(info_logs.output, [ - f'INFO:{logger_string}:Soft Deactivated user {long_term_idle_user.id}', + f'INFO:{logger_string}:Soft deactivated user {long_term_idle_user.id}', f'INFO:{logger_string}:Soft-deactivated batch of 1 users; 0 remain to process' ]) @@ -357,7 +357,7 @@ class SoftDeactivationMessageTest(ZulipTestCase): with self.assertLogs(logger_string, level='INFO') as info_logs: do_soft_deactivate_users([long_term_idle_user]) self.assertEqual(info_logs.output, [ - f'INFO:{logger_string}:Soft Deactivated user {long_term_idle_user.id}', + f'INFO:{logger_string}:Soft deactivated user {long_term_idle_user.id}', f'INFO:{logger_string}:Soft-deactivated batch of 1 users; 0 remain to process' ]) @@ -464,7 +464,7 @@ class SoftDeactivationMessageTest(ZulipTestCase): with self.assertLogs(logger_string, level='INFO') as info_logs: do_soft_deactivate_users([long_term_idle_user]) self.assertEqual(info_logs.output, [ - f'INFO:{logger_string}:Soft Deactivated user {long_term_idle_user.id}', + f'INFO:{logger_string}:Soft deactivated user {long_term_idle_user.id}', f'INFO:{logger_string}:Soft-deactivated batch of 1 users; 0 remain to process' ]) send_fake_message('Test Message 10', stream) @@ -524,7 +524,7 @@ class SoftDeactivationMessageTest(ZulipTestCase): with self.assertLogs(logger_string, level='INFO') as info_logs: do_soft_deactivate_users([long_term_idle_user]) self.assertEqual(info_logs.output, [ - f'INFO:{logger_string}:Soft Deactivated user {long_term_idle_user.id}', + f'INFO:{logger_string}:Soft deactivated user {long_term_idle_user.id}', f'INFO:{logger_string}:Soft-deactivated batch of 1 users; 0 remain to process' ]) @@ -573,7 +573,7 @@ class SoftDeactivationMessageTest(ZulipTestCase): with self.assertLogs(logger_string, level='INFO') as info_logs: do_soft_deactivate_users([long_term_idle_user]) self.assertEqual(info_logs.output, [ - f'INFO:{logger_string}:Soft Deactivated user {long_term_idle_user.id}', + f'INFO:{logger_string}:Soft deactivated user {long_term_idle_user.id}', f'INFO:{logger_string}:Soft-deactivated batch of 1 users; 0 remain to process' ]) diff --git a/zerver/tests/test_subs.py b/zerver/tests/test_subs.py index cf9e395e39..a44951ca58 100644 --- a/zerver/tests/test_subs.py +++ b/zerver/tests/test_subs.py @@ -710,18 +710,18 @@ class StreamAdminTest(ZulipTestCase): self.assertNotIn(self.example_user('polonius').id, notified_user_ids) - # Test case to handle unicode stream name change - # *NOTE: Here Encoding is needed when Unicode string is passed as an argument* + # Test case to handle Unicode stream name change + # *NOTE: Here encoding is needed when Unicode string is passed as an argument* with tornado_redirected_to_list(events): stream_id = stream_name2_exists.id result = self.client_patch(f'/json/streams/{stream_id}', {'new_name': orjson.dumps('नया नाम').decode()}) self.assert_json_success(result) - # While querying, system can handle unicode strings. + # While querying, system can handle Unicode strings. stream_name_uni_exists = get_stream('नया नाम', realm) self.assertTrue(stream_name_uni_exists) - # Test case to handle changing of unicode stream name to newer name + # Test case to handle changing of Unicode stream name to newer name # NOTE: Unicode string being part of URL is handled cleanly # by client_patch call, encoding of URL is not needed. with tornado_redirected_to_list(events): @@ -729,7 +729,7 @@ class StreamAdminTest(ZulipTestCase): result = self.client_patch(f'/json/streams/{stream_id}', {'new_name': orjson.dumps('नाम में क्या रक्खा हे').decode()}) self.assert_json_success(result) - # While querying, system can handle unicode strings. + # While querying, system can handle Unicode strings. self.assertRaises(Stream.DoesNotExist, get_stream, 'नया नाम', realm) stream_name_new_uni_exists = get_stream('नाम में क्या रक्खा हे', realm) diff --git a/zerver/tests/test_thumbnail.py b/zerver/tests/test_thumbnail.py index 7f440c7184..66ba1df24f 100644 --- a/zerver/tests/test_thumbnail.py +++ b/zerver/tests/test_thumbnail.py @@ -60,7 +60,7 @@ class ThumbnailTest(ZulipTestCase): expected_part_url = get_file_path_urlpart(uri, '0x300') self.assertIn(expected_part_url, result.url) - # Test custom emoji urls in Zulip messages. + # Test custom emoji URLs in Zulip messages. user_profile = self.example_user("hamlet") image_file = get_test_image_file("img.png") file_name = "emoji.png" @@ -77,7 +77,7 @@ class ThumbnailTest(ZulipTestCase): self.assertEqual(result.status_code, 302, result) self.assertIn(custom_emoji_url, result.url) - # Tests the /api/v1/thumbnail api endpoint with standard API auth + # Tests the /api/v1/thumbnail API endpoint with standard API auth self.logout() result = self.api_get( hamlet, @@ -109,7 +109,7 @@ class ThumbnailTest(ZulipTestCase): expected_part_url = '/0x300/smart/filters:no_upscale():sharpen(0.5,0.2,true)/' + encoded_url + '/source_type/external' self.assertIn(expected_part_url, result.url) - # Test api endpoint with standard API authentication. + # Test API endpoint with standard API authentication. self.logout() user_profile = self.example_user("hamlet") result = self.api_get(user_profile, @@ -118,7 +118,7 @@ class ThumbnailTest(ZulipTestCase): expected_part_url = '/0x300/smart/filters:no_upscale():sharpen(0.5,0.2,true)/' + encoded_url + '/source_type/external' self.assertIn(expected_part_url, result.url) - # Test api endpoint with legacy API authentication. + # Test API endpoint with legacy API authentication. user_profile = self.example_user("hamlet") result = self.client_get(f"/thumbnail?url={quoted_url}&size=thumbnail&api_key={get_api_key(user_profile)}") self.assertEqual(result.status_code, 302, result) @@ -186,7 +186,7 @@ class ThumbnailTest(ZulipTestCase): expected_part_url = get_file_path_urlpart(uri, '0x300') self.assertIn(expected_part_url, result.url) - # Test with a unicode filename. + # Test with a Unicode filename. fp = StringIO("zulip!") fp.name = "μένει.jpg" @@ -221,7 +221,7 @@ class ThumbnailTest(ZulipTestCase): self.assertEqual(result.status_code, 302, result) self.assertIn(custom_emoji_url, result.url) - # Tests the /api/v1/thumbnail api endpoint with HTTP basic auth. + # Tests the /api/v1/thumbnail API endpoint with HTTP basic auth. self.logout() user_profile = self.example_user("hamlet") result = self.api_get( @@ -231,7 +231,7 @@ class ThumbnailTest(ZulipTestCase): expected_part_url = get_file_path_urlpart(uri) self.assertIn(expected_part_url, result.url) - # Tests the /api/v1/thumbnail api endpoint with ?api_key + # Tests the /api/v1/thumbnail API endpoint with ?api_key # auth. user_profile = self.example_user("hamlet") result = self.client_get( diff --git a/zerver/tests/test_upload.py b/zerver/tests/test_upload.py index ff8da24864..35a58e64ad 100644 --- a/zerver/tests/test_upload.py +++ b/zerver/tests/test_upload.py @@ -81,7 +81,7 @@ class FileUploadTest(UploadSerializeMixin, ZulipTestCase): def test_rest_endpoint(self) -> None: """ - Tests the /api/v1/user_uploads api endpoint. Here a single file is uploaded + Tests the /api/v1/user_uploads API endpoint. Here a single file is uploaded and downloaded using a username and api_key """ fp = StringIO("zulip!") @@ -107,7 +107,7 @@ class FileUploadTest(UploadSerializeMixin, ZulipTestCase): def test_mobile_api_endpoint(self) -> None: """ - Tests the /api/v1/user_uploads api endpoint with ?api_key + Tests the /api/v1/user_uploads API endpoint with ?api_key auth. Here a single file is uploaded and downloaded using a username and api_key """ @@ -186,7 +186,7 @@ class FileUploadTest(UploadSerializeMixin, ZulipTestCase): self.assert_json_error(result, "You must specify a file to upload") # This test will go through the code path for uploading files onto LOCAL storage - # when zulip is in DEVELOPMENT mode. + # when Zulip is in DEVELOPMENT mode. def test_file_upload_authed(self) -> None: """ A call to /json/user_uploads should return a uri and actually create an @@ -216,7 +216,7 @@ class FileUploadTest(UploadSerializeMixin, ZulipTestCase): body = "First message ...[zulip.txt](http://localhost:9991" + uri + ")" self.send_stream_message(self.example_user("hamlet"), "Denmark", body, "test") - # Now try the endpoint that's supposed to return a temporary url for access + # Now try the endpoint that's supposed to return a temporary URL for access # to the file. result = self.client_get('/json' + uri) self.assert_json_success(result) @@ -226,7 +226,7 @@ class FileUploadTest(UploadSerializeMixin, ZulipTestCase): self.assertNotEqual(url_only_url, uri) self.assertIn('user_uploads/temporary/', url_only_url) self.assertTrue(url_only_url.endswith('zulip.txt')) - # The generated url has a token authorizing the requestor to access the file + # The generated URL has a token authorizing the requestor to access the file # without being logged in. self.logout() self.assert_url_serves_contents_of_file(url_only_url, b"zulip!") @@ -1041,7 +1041,7 @@ class AvatarTest(UploadSerializeMixin, ZulipTestCase): def test_valid_avatars(self) -> None: """ - A PUT request to /json/users/me/avatar with a valid file should return a url and actually create an avatar. + A PUT request to /json/users/me/avatar with a valid file should return a URL and actually create an avatar. """ version = 2 for fname, rfname in self.correct_files: @@ -1281,7 +1281,7 @@ class RealmIconTest(UploadSerializeMixin, ZulipTestCase): def test_valid_icons(self) -> None: """ - A PUT request to /json/realm/icon with a valid file should return a url + A PUT request to /json/realm/icon with a valid file should return a URL and actually create an realm icon. """ for fname, rfname in self.correct_files: @@ -1437,7 +1437,7 @@ class RealmLogoTest(UploadSerializeMixin, ZulipTestCase): def test_valid_logos(self) -> None: """ - A PUT request to /json/realm/logo with a valid file should return a url + A PUT request to /json/realm/logo with a valid file should return a URL and actually create an realm logo. """ for fname, rfname in self.correct_files: @@ -1687,7 +1687,7 @@ class S3Test(ZulipTestCase): key = path[1:] self.assertEqual(b"zulip!", bucket.Object(key).get()['Body'].read()) - # Now try the endpoint that's supposed to return a temporary url for access + # Now try the endpoint that's supposed to return a temporary URL for access # to the file. result = self.client_get('/json' + uri) self.assert_json_success(result) diff --git a/zerver/tests/test_users.py b/zerver/tests/test_users.py index fac178a719..321b4c195e 100644 --- a/zerver/tests/test_users.py +++ b/zerver/tests/test_users.py @@ -771,7 +771,7 @@ class BulkCreateUserTest(ZulipTestCase): realm.save() name_list = [ - ('Fred Flinstone', 'fred@zulip.com'), + ('Fred Flintstone', 'fred@zulip.com'), ('Lisa Simpson', 'lisa@zulip.com'), ] @@ -1232,7 +1232,7 @@ class ActivateTest(ZulipTestCase): def test_api_with_nonexistent_user(self) -> None: self.login('iago') - # Organization Administrator cannot deactivate organization owner. + # Organization administrator cannot deactivate organization owner. result = self.client_delete(f'/json/users/{self.example_user("desdemona").id}') self.assert_json_error(result, 'Must be an organization owner') @@ -1643,7 +1643,7 @@ class GetProfileTest(ZulipTestCase): self.assertTrue(result['is_owner']) self.assertFalse(result['is_guest']) - # Tests the GET ../users/{id} api endpoint. + # Tests the GET ../users/{id} API endpoint. user = self.example_user('hamlet') result = orjson.loads(self.client_get(f'/json/users/{user.id}').content) self.assertEqual(result['user']['email'], user.email) diff --git a/zerver/tornado/application.py b/zerver/tornado/application.py index a1fee11ac1..10361fcfe9 100644 --- a/zerver/tornado/application.py +++ b/zerver/tornado/application.py @@ -9,7 +9,7 @@ from zerver.tornado.handlers import AsyncDjangoHandler def setup_tornado_rabbitmq() -> None: # nocoverage - # When tornado is shut down, disconnect cleanly from rabbitmq + # When tornado is shut down, disconnect cleanly from RabbitMQ if settings.USING_RABBITMQ: queue_client = get_queue_client() atexit.register(lambda: queue_client.close()) diff --git a/zerver/views/auth.py b/zerver/views/auth.py index 2a2ea35e1d..ceb171bf7c 100644 --- a/zerver/views/auth.py +++ b/zerver/views/auth.py @@ -550,7 +550,7 @@ def log_into_subdomain(request: HttpRequest, token: str) -> HttpResponse: """Given a valid authentication token (generated by redirect_and_log_into_subdomain called on auth.zulip.example.com), call login_or_register_remote_user, passing all the authentication - result data that has been stored in redis, associated with this token. + result data that has been stored in Redis, associated with this token. """ # The tokens are intended to have the same format as API keys. if not has_api_key_format(token): diff --git a/zerver/views/development/registration.py b/zerver/views/development/registration.py index 849151234f..ad2295279b 100644 --- a/zerver/views/development/registration.py +++ b/zerver/views/development/registration.py @@ -12,7 +12,7 @@ from zerver.views.auth import create_preregistration_user from zerver.views.registration import accounts_register -# This is used only by the puppeteer test in 00-realm-creation.js. +# This is used only by the Puppeteer test in 00-realm-creation.js. def confirmation_key(request: HttpRequest) -> HttpResponse: return json_success(request.session.get('confirmation_key')) diff --git a/zerver/views/documentation.py b/zerver/views/documentation.py index b2cdba721f..71938c1080 100644 --- a/zerver/views/documentation.py +++ b/zerver/views/documentation.py @@ -96,7 +96,7 @@ class MarkdownDirectoryView(ApiURLView): context["page_is_api_center"] = True context["doc_root"] = "/api/" (sidebar_index, http_status_ignored) = self.get_path("sidebar_index") - title_base = "Zulip API Documentation" + title_base = "Zulip API documentation" # The following is a somewhat hacky approach to extract titles from articles. # Hack: `context["article"] has a leading `/`, so we use + to add directories. diff --git a/zerver/views/message_fetch.py b/zerver/views/message_fetch.py index abf60857b3..b68f06f0f7 100644 --- a/zerver/views/message_fetch.py +++ b/zerver/views/message_fetch.py @@ -227,15 +227,15 @@ class NarrowBuilder: """ Escape user input to place in a regex - Python's re.escape escapes unicode characters in a way which postgres + Python's re.escape escapes Unicode characters in a way which Postgres fails on, '\u03bb' to '\\\u03bb'. This function will correctly escape - them for postgres, '\u03bb' to '\\u03bb'. + them for Postgres, '\u03bb' to '\\u03bb'. """ s = list(pattern) for i, c in enumerate(s): if c not in self._alphanum: if ord(c) >= 128: - # convert the character to hex postgres regex will take + # convert the character to hex Postgres regex will take # \uXXXX s[i] = f'\\u{ord(c):0>4x}' else: @@ -325,7 +325,7 @@ class NarrowBuilder: topic_match_sa('(instance "").d.d.d.d'), ) else: - # We limit `.d` counts, since postgres has much better + # We limit `.d` counts, since Postgres has much better # query planning for this than they do for a regular # expression (which would sometimes table scan). cond = or_( diff --git a/zerver/views/realm_icon.py b/zerver/views/realm_icon.py index 2a4c270159..25eae53d36 100644 --- a/zerver/views/realm_icon.py +++ b/zerver/views/realm_icon.py @@ -49,7 +49,7 @@ def delete_icon_backend(request: HttpRequest, user_profile: UserProfile) -> Http def get_icon_backend(request: HttpRequest, user_profile: UserProfile) -> HttpResponse: url = realm_icon_url(user_profile.realm) - # We can rely on the url already having query parameters. Because + # We can rely on the URL already having query parameters. Because # our templates depend on being able to use the ampersand to # add query parameters to our url, get_icon_url does '?version=version_number' # hacks to prevent us from having to jump through decode/encode hoops. diff --git a/zerver/views/realm_logo.py b/zerver/views/realm_logo.py index de43224160..cb00357ee2 100644 --- a/zerver/views/realm_logo.py +++ b/zerver/views/realm_logo.py @@ -46,7 +46,7 @@ def get_logo_backend(request: HttpRequest, user_profile: UserProfile, night: bool=REQ(validator=check_bool)) -> HttpResponse: url = get_realm_logo_url(user_profile.realm, night) - # We can rely on the url already having query parameters. Because + # We can rely on the URL already having query parameters. Because # our templates depend on being able to use the ampersand to # add query parameters to our url, get_logo_url does '?version=version_number' # hacks to prevent us from having to jump through decode/encode hoops. diff --git a/zerver/views/registration.py b/zerver/views/registration.py index 35e16d0643..62f62362c7 100644 --- a/zerver/views/registration.py +++ b/zerver/views/registration.py @@ -333,7 +333,7 @@ def accounts_register(request: HttpRequest) -> HttpResponse: if user_profile is None: can_use_different_backend = email_auth_enabled(realm) or any_social_backend_enabled(realm) if settings.LDAP_APPEND_DOMAIN: - # In LDAP_APPEND_DOMAIN configurations, we don't allow making a non-ldap account + # In LDAP_APPEND_DOMAIN configurations, we don't allow making a non-LDAP account # if the email matches the ldap domain. can_use_different_backend = can_use_different_backend and ( not email_belongs_to_ldap(realm, email)) diff --git a/zerver/views/users.py b/zerver/views/users.py index be5c3dcf3a..93b1056c6f 100644 --- a/zerver/views/users.py +++ b/zerver/views/users.py @@ -199,7 +199,7 @@ def avatar(request: HttpRequest, user_profile: UserProfile, avatar_version = 1 url = get_gravatar_url(email, avatar_version, medium) - # We can rely on the url already having query parameters. Because + # We can rely on the URL already having query parameters. Because # our templates depend on being able to use the ampersand to # add query parameters to our url, get_avatar_url does '?x=x' # hacks to prevent us from having to jump through decode/encode hoops. diff --git a/zerver/views/video_calls.py b/zerver/views/video_calls.py index 867f5e1e1e..78b8ad1218 100644 --- a/zerver/views/video_calls.py +++ b/zerver/views/video_calls.py @@ -162,7 +162,7 @@ def deauthorize_zoom_user(request: HttpRequest) -> HttpResponse: def get_bigbluebutton_url(request: HttpRequest, user_profile: UserProfile) -> HttpResponse: - # https://docs.bigbluebutton.org/dev/api.html#create for reference on the api calls + # https://docs.bigbluebutton.org/dev/api.html#create for reference on the API calls # https://docs.bigbluebutton.org/dev/api.html#usage for reference for checksum id = "zulip-" + str(random.randint(100000000000, 999999999999)) password = b32encode(secrets.token_bytes(7))[:10].decode() diff --git a/zerver/views/zephyr.py b/zerver/views/zephyr.py index 61d50cda36..fabdeb162a 100644 --- a/zerver/views/zephyr.py +++ b/zerver/views/zephyr.py @@ -55,7 +55,7 @@ def webathena_kerberos_login(request: HttpRequest, user_profile: UserProfile, except Exception: return json_error(_("Invalid Kerberos cache")) - # TODO: Send these data via (say) rabbitmq + # TODO: Send these data via (say) RabbitMQ try: api_key = get_api_key(user_profile) command = [ diff --git a/zerver/webhooks/alertmanager/doc.md b/zerver/webhooks/alertmanager/doc.md index 6bf8063e27..e278497666 100644 --- a/zerver/webhooks/alertmanager/doc.md +++ b/zerver/webhooks/alertmanager/doc.md @@ -1,4 +1,4 @@ -Get Zulip notifications from AlertManager! +Get Zulip notifications from Alertmanager! 1. {!create-stream.md!} @@ -10,12 +10,12 @@ Get Zulip notifications from AlertManager! {{ api_url }}{{ integration_url }}?api_key=abcdefgh&stream=stream%20name&name=host&desc=alertname -1. In your AlertManager config, set up a new webhook receiver, like so: +1. In your Alertmanager config, set up a new webhook receiver, like so: ``` - name: ops-zulip webhook_configs: - - url: "