From 206247f5437ee4e2b202299422fa31a562c0db5f Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Wed, 21 May 2025 17:01:01 -0400 Subject: [PATCH] Clean up typos This changeset cleans up a variety of typos that were found and submitted in PR #2588; we cannot directly accept external contributions, but we appreciate the flagging of things like this! Signed-off-by: Carlo Costino --- README.md | 2 +- docs/docker-remote-containers.md | 2 +- docs/feature-flagging.md | 2 +- docs/sprint-goals.md | 18 +++++++++--------- .../clients/redis/redis_client.py | 2 +- notifications_utils/formatters.py | 2 +- notifications_utils/insensitive_dict.py | 4 ++-- .../international_billing_rates.yml | 4 ++-- notifications_utils/recipients.py | 2 +- notifications_utils/serialised_model.py | 2 +- notifications_utils/template.py | 2 +- 11 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 95a07dbd3..9313a6f88 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ You will need the following items: [setting up an account](https://cloud.gov/sign-up/) (requires a `.mil`, `.gov`, or `.fed.us` email address) and getting access to the `notify-local-dev` and `notify-staging` spaces. -- Admin priviliges and SSH access on your machine; you may need to work with +- Admin privileges and SSH access on your machine; you may need to work with your organization's IT support staff if you're not sure or don't currently have this access. diff --git a/docs/docker-remote-containers.md b/docs/docker-remote-containers.md index 22099c870..945a182d6 100644 --- a/docs/docker-remote-containers.md +++ b/docs/docker-remote-containers.md @@ -18,4 +18,4 @@ If you're working in VS Code, you can also leverage Docker for a containerized d 1. Go to http://localhost:6012 -NOTE: when you change .env in the future, you'll need to rebuild the devcontainer for the change to take effect. VS Code _should_ detect the change and prompt you with a toast notification during a cached build. If not, you can find a manual rebuild in command pallette or just `docker rm` the notifications-api container. +NOTE: when you change .env in the future, you'll need to rebuild the devcontainer for the change to take effect. VS Code _should_ detect the change and prompt you with a toast notification during a cached build. If not, you can find a manual rebuild in command palette or just `docker rm` the notifications-api container. diff --git a/docs/feature-flagging.md b/docs/feature-flagging.md index ecefa2250..1dd8af161 100644 --- a/docs/feature-flagging.md +++ b/docs/feature-flagging.md @@ -2,7 +2,7 @@ ## Using Environment Variables -This guide explains how to update cloud foundry envirionment variables to enable or disable feature flagging. +This guide explains how to update cloud foundry environment variables to enable or disable feature flagging. ### Prerequisites diff --git a/docs/sprint-goals.md b/docs/sprint-goals.md index b779d45e7..cedaea428 100644 --- a/docs/sprint-goals.md +++ b/docs/sprint-goals.md @@ -6,10 +6,10 @@ | | Goals | Impact | Milestone(s) | |-------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|--------------| | Engineering | Get `staging` stable and bugs fixed in order to do a prod push, finalize Login.gov implementation, complete epic to [remove phone numbers from db](https://github.com/GSA/notifications-api/issues/667), [calculate pre-send message parts](https://github.com/GSA/notifications-admin/issues/1027) to add to confirmation page, finish [E2E testing implementation](https://github.com/GSA/notifications-admin/issues/677), set up [opt-out lists by phone number](https://github.com/GSA/notifications-api/issues/312) | Install required auth, expand message send volume for partners, allow users to see how many parts a send will cost, improve app stability, partition opt-outs so that they aren't across the system | Building Notify.gov | -| UX | [Tackle `Usage and Performance` epic](https://github.com/GSA/notifications-admin/issues/1108) as highest priority group of user stories, break out UX work into more user-stories and correlating epics, prioritize epic/story order, improve [pre-send confirmation page](https://github.com/GSA/notifications-admin/issues/815)| Improve UX | Building Notify.gov| +| UX | [Tackle `Usage and Performance` epic](https://github.com/GSA/notifications-admin/issues/1108) as highest priority group of user stories, break out UX work into more user-stories and correlating epics, prioritize epic/story order, improve [pre-send confirmation page](https://github.com/GSA/notifications-admin/issues/815)| Improve UX | Building Notify.gov| | Security | Complete necessary control families | Aim to have package completed with enough time to allow for long assessment| Secure ATO | | Content | Get [refreshed content for `Using Notify` pages](https://github.com/GSA/notifications-admin/issues/449) in place, make content [more clear about limits](https://github.com/GSA/notifications-admin/issues/963), make content clearer by [adding `parts` where necessary](https://github.com/GSA/notifications-admin/issues/963) | Improve clarity of message parts for users, bring existing content into current state| Building Notify.gov | -| Ops | Assist in Tech to Gov process, plan gap coverage for Tim's departure 2/9 | +| Ops | Assist in Tech to Gov process, plan gap coverage for Tim's departure 2/9 | ## Sprint: Akhlut (1/3/24) 2024 Sprints will be named after mythical creatures @@ -17,7 +17,7 @@ | | Goals | Impact | Milestone(s) | |-------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|--------------| | Engineering | Continue [identifying](https://github.com/GSA/notifications-api/issues/656), [fixing](https://github.com/GSA/notifications-api/issues/645), and [displaying](https://github.com/GSA/notifications-admin/issues/964) various applicable message part limits, devise ways to [create better access to reports](https://github.com/GSA/notifications-admin/issues/855), implement Login.gov on staging environment, advance epic to [remove phone numbers from db](https://github.com/GSA/notifications-api/issues/667) | Better track annual and smart-retention limits, install required auth, make reports easier to find, expand message send volume for partners | Building Notify.gov | -| UX | Spin up weekly [redesign syncs](https://github.com/GSA/notifications-admin/issues/1061), identify necessary dashboard metrics to visualize, improve [team member section](https://github.com/GSA/notifications-admin/issues/1031)| Improve UX | Building Notify.gov| +| UX | Spin up weekly [redesign syncs](https://github.com/GSA/notifications-admin/issues/1061), identify necessary dashboard metrics to visualize, improve [team member section](https://github.com/GSA/notifications-admin/issues/1031)| Improve UX | Building Notify.gov| | Security | Complete necessary control families | Aim to have package completed with enough time to allow for long assessment| Secure ATO | | Content | Finish making [editing content easier](https://github.com/GSA/notifications-admin/issues/976) with existing templates, finalize decision on terminology regarding [batch/campaign/job](https://github.com/GSA/notifications-admin/issues/1060), make content [more clear about limits](https://github.com/GSA/notifications-admin/issues/963), make content clearer by [adding `parts` where necessary](https://github.com/GSA/notifications-admin/issues/963) | Improve clarity of message parts for users, streamline content editing for the team| Building Notify.gov | | Ops | Assist in Tech to Gov process | | @@ -28,7 +28,7 @@ Sprint velocity was very low due to holiday OOO | | Goals | Impact | Milestone(s) | |-------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|--------------| | Engineering | Spend time [identifying](https://github.com/GSA/notifications-api/issues/656), [fixing](https://github.com/GSA/notifications-api/issues/645), and [displaying](https://github.com/GSA/notifications-admin/issues/964) various applicable message part limits, devise ways to [create better access to reports](https://github.com/GSA/notifications-admin/issues/855), implement Login.gov on staging environment, advance epic to [remove phone numbers from db](https://github.com/GSA/notifications-api/issues/667) | Better track annual and smart-retention limits, install required auth, make reports easier to find, expand message send volume for partners | Building Notify.gov | -| UX | [Re-think Notify IA](https://github.com/GSA/notifications-admin/issues/910), start implementing dashboard changes, improve [team member section](https://github.com/GSA/notifications-admin/issues/1031)| Improve UX | Building Notify.gov| +| UX | [Re-think Notify IA](https://github.com/GSA/notifications-admin/issues/910), start implementing dashboard changes, improve [team member section](https://github.com/GSA/notifications-admin/issues/1031)| Improve UX | Building Notify.gov| | Security | Complete necessary control families | Aim to have package completed with enough time to allow for long assessment| Secure ATO | | Content | Make content [more clear about limits](https://github.com/GSA/notifications-admin/issues/963), make content clearer by [adding `parts` where necessary](https://github.com/GSA/notifications-admin/issues/963), test making [editing content easier](https://github.com/GSA/notifications-admin/issues/976) with existing templates | Improve clarity of message parts for users, streamline content editing for the team| Building Notify.gov | | Ops | Assist in Tech to Gov process | | @@ -39,10 +39,10 @@ Sprint velocity was very low due to holiday OOO | | Goals | Impact | Milestone(s) | |-------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|--------------| | Engineering | Spend time [identifying](https://github.com/GSA/notifications-api/issues/656), [fixing](https://github.com/GSA/notifications-api/issues/645), and [displaying](https://github.com/GSA/notifications-admin/issues/964) various applicable message part limits, devise ways to [create better access to reports](https://github.com/GSA/notifications-admin/issues/855), implement Login.gov on staging environment | Better track annual and smart-retention limits, continuity between application orgs and agreements | Building Notify.gov | -| UX | [Re-think Notify IA](https://github.com/GSA/notifications-admin/issues/910), start implementing dashboard changes, obtain requested user feedback on [Notify logo](https://github.com/GSA/notifications-admin/issues/859) proposal | Improve ease of use, begin process of brand creation | Obbtain approval for logo/brand| +| UX | [Re-think Notify IA](https://github.com/GSA/notifications-admin/issues/910), start implementing dashboard changes, obtain requested user feedback on [Notify logo](https://github.com/GSA/notifications-admin/issues/859) proposal | Improve ease of use, begin process of brand creation | Obbtain approval for logo/brand| | Security | Complete [CP family of controls](https://github.com/GSA/us-notify-compliance/issues/42), Draft [config management plan](https://github.com/GSA/us-notify-compliance/issues/35) | Aim to have package completed with enough time to allow for long assessment| Secure ATO | | Content | Make content (and MOUs) [more clear about limits](https://github.com/GSA/notifications-admin/issues/963), test making [editing content easier](https://github.com/GSA/notifications-admin/issues/976) with existing templates | Improve clarity of message parts for users, streamline content editing for the team| Building Notify.gov | -| Ops | | +| Ops | | ## Sprint: Wallcreeper (11/8/23) (Sprint is at low capacity due to Thanksgiving week) @@ -50,7 +50,7 @@ Sprint velocity was very low due to holiday OOO | | Goals | Impact | Milestone(s) | |-------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|--------------| | Engineering | Change timezones displays to [Eastern time](https://github.com/GSA/notifications-admin/issues/861), [create properties on org model](https://github.com/GSA/notifications-api/issues/331) to process agreement info | Better timezone familiarity, continuity between application orgs and agreements | Building Notify.gov | -| UX | Begin [re-thinking Notify IA](https://github.com/GSA/notifications-admin/issues/910), create a synthesis of partner feeback thusfar, wireframe a more [user-friendly dashboard](https://github.com/GSA/notifications-admin/issues/889), send [Notify logo](https://github.com/GSA/notifications-admin/issues/859) proposal to begin approvals, add UI consideration regarding [multi-lingual messages](https://github.com/GSA/notifications-admin/issues/901) | Improve ease of use, begin process of brand creation | Obtain approval for logo/brand| +| UX | Begin [re-thinking Notify IA](https://github.com/GSA/notifications-admin/issues/910), create a synthesis of partner feedback thusfar, wireframe a more [user-friendly dashboard](https://github.com/GSA/notifications-admin/issues/889), send [Notify logo](https://github.com/GSA/notifications-admin/issues/859) proposal to begin approvals, add UI consideration regarding [multi-lingual messages](https://github.com/GSA/notifications-admin/issues/901) | Improve ease of use, begin process of brand creation | Obtain approval for logo/brand| | Security | Complete pre-requisite documentation, start project planning timelines and control group deadlines | Aim to have package completed with enough time to allow for long assessment| Secure ATO | | Content | Finalize cloud.gov pages IAA mod for content site | Enable an easy static website for future content | Building Notify.gov | | Ops | Complete Beverly's onboarding with necessary access to cloud.gov, AWS, and other tools| Add valuable dev resources to increase our capacity @@ -59,7 +59,7 @@ Sprint velocity was very low due to holiday OOO | | Goals | Impact | |-------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| -| Engineering | Continue login.gov [sandbox implementation](https://github.com/GSA/notifications-admin/issues/338), catch up deploys that lag from last week's dependency audit failures, change timezones displays to [Eastern time](https://github.com/GSA/notifications-admin/issues/861), Persist [individal send reports](https://github.com/GSA/notifications-admin/issues/855) somwehere in the app| Stronger auth security, streamlined UX, better timezone familiarity | +| Engineering | Continue login.gov [sandbox implementation](https://github.com/GSA/notifications-admin/issues/338), catch up deploys that lag from last week's dependency audit failures, change timezones displays to [Eastern time](https://github.com/GSA/notifications-admin/issues/861), Persist [individual send reports](https://github.com/GSA/notifications-admin/issues/855) somwehere in the app| Stronger auth security, streamlined UX, better timezone familiarity | | UX | Continue making common-sense [UI/UX changes](https://github.com/GSA/notifications-admin/issues/828), review and finalize proposal for [Notify logo](https://github.com/GSA/notifications-admin/issues/859) & begin approvals chain | Improve ease of use, begin process of brand creation | | Security | Complete pre-requisite documentation, start project planning timelines and control group deadlines | Aim to have package completed with enough time to allow for long assessment| | Content | Finalize cloud.gov pages IAA mod for content site | Enable an easy static website for future content | @@ -117,7 +117,7 @@ Sprint velocity was very low due to holiday OOO | | Goals | Impact | |-------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| | Engineering | (Due to low engineering availability, the goals from last sprint continue) Reduce [technical debt](https://github.com/GSA/notifications-api/issues/361) and stabilize application; carry out rigorous [testing](https://github.com/GSA/notifications-api/issues/312) of features and [infrastructure](https://github.com/GSA/notifications-api/issues/87); solve known [bugs](https://github.com/GSA/notifications-api/issues/360) | Increase app reliability prior to first partner use | -| UX | Analyze data gathered from user-testing and propose changes from that analyzation; Hone a visual brand strategy for proposal to leadership | Improve upon oft-identified user barriers; create a consisten look and feel for Notify.gov | +| UX | Analyze data gathered from user-testing and propose changes from that analyzation; Hone a visual brand strategy for proposal to leadership | Improve upon oft-identified user barriers; create a consistent look and feel for Notify.gov | | Security | Respond to any assessment questions and/or needs (assessment is nearing end) | Keep the LATO award timeline as short as possible| | Content | Collate research to inform future best practices content | Have content ready for later addition to the site diff --git a/notifications_utils/clients/redis/redis_client.py b/notifications_utils/clients/redis/redis_client.py index 469cd7c8f..8543e27ba 100644 --- a/notifications_utils/clients/redis/redis_client.py +++ b/notifications_utils/clients/redis/redis_client.py @@ -103,7 +103,7 @@ class RedisClient: Notes: - Failed requests count. If over the limit and keep making requests you'll stay over the limit. - - The actual value in the set is just the timestamp, the same as the score. We don't store any requets details. + - The actual value in the set is just the timestamp, the same as the score. We don't store any request details. - return value of pipe.execute() is an array containing the outcome of each call. - result[2] == outcome of pipe.zcard() - If redis is inactive, or we get an exception, allow the request diff --git a/notifications_utils/formatters.py b/notifications_utils/formatters.py index c5bdef840..3c37eda8b 100644 --- a/notifications_utils/formatters.py +++ b/notifications_utils/formatters.py @@ -338,7 +338,7 @@ def strip_and_remove_obscure_whitespace(value): def remove_whitespace(value): - # Removes ALL whitespace, not just the obscure characters we normaly remove + # Removes ALL whitespace, not just the obscure characters we normally remove for character in ALL_WHITESPACE: value = value.replace(character, "") diff --git a/notifications_utils/insensitive_dict.py b/notifications_utils/insensitive_dict.py index 7b239b884..75e3532f0 100644 --- a/notifications_utils/insensitive_dict.py +++ b/notifications_utils/insensitive_dict.py @@ -6,7 +6,7 @@ from ordered_set import OrderedSet class InsensitiveDict(dict): """ `InsensitiveDict` behaves like an ordered dictionary, except it normalises - case, whitespace, hypens and underscores in keys. + case, whitespace, hyphens and underscores in keys. In other words, InsensitiveDict({'FIRST_NAME': 'example'}) == InsensitiveDict({'first name': 'example'}) @@ -23,7 +23,7 @@ class InsensitiveDict(dict): def from_keys(cls, keys): """ This behaves like `dict.from_keys`, except: - - it normalises the keys to ignore case, whitespace, hypens and + - it normalises the keys to ignore case, whitespace, hyphens and underscores - it stores the original, unnormalised key as the value of the item so it can be retrieved later diff --git a/notifications_utils/international_billing_rates.yml b/notifications_utils/international_billing_rates.yml index dfa87d490..44d95e3d6 100644 --- a/notifications_utils/international_billing_rates.yml +++ b/notifications_utils/international_billing_rates.yml @@ -510,7 +510,7 @@ '66': attributes: alpha: REG - comment: Maximum long message lenght is 459 for GSM7 or 201 for Unicode alphabet. + comment: Maximum long message length is 459 for GSM7 or 201 for Unicode alphabet. Special registration procedure for sending to DND numbers dlr: 'YES' generic_sender: SMS @@ -577,7 +577,7 @@ sender_and_registration_info: All senders CONVERTED into one available national numeric sender text_restrictions: Content template MUST be approved by the MNO. Transactional - traffic ONLY. Sufix added in the message text + traffic ONLY. Suffix added in the message text billable_units: 1 names: - China diff --git a/notifications_utils/recipients.py b/notifications_utils/recipients.py index 1e8aeff6d..4303ea5a6 100644 --- a/notifications_utils/recipients.py +++ b/notifications_utils/recipients.py @@ -652,7 +652,7 @@ def _do_simple_email_checks(match, email_address): def validate_email_address(email_address): # noqa (C901 too complex) # almost exactly the same as by https://github.com/wtforms/wtforms/blob/master/wtforms/validators.py, # with minor tweaks for SES compatibility - to avoid complications we are a lot stricter with the local part - # than neccessary - we don't allow any double quotes or semicolons to prevent SES Technical Failures + # than necessary - we don't allow any double quotes or semicolons to prevent SES Technical Failures email_address = strip_and_remove_obscure_whitespace(email_address) match = re.match(EMAIL_REGEX_PATTERN, email_address) diff --git a/notifications_utils/serialised_model.py b/notifications_utils/serialised_model.py index 8e925008e..159ba29d1 100644 --- a/notifications_utils/serialised_model.py +++ b/notifications_utils/serialised_model.py @@ -11,7 +11,7 @@ class SerialisedModel(ABC): guarantees that: - all of the ALLOWED_PROPERTIES are present in the underlying dictionary - - any other abritrary properties of the underlying dictionary can’t + - any other arbitrary properties of the underlying dictionary can’t be accessed If you are adding a new field to a model, you should ensure that diff --git a/notifications_utils/template.py b/notifications_utils/template.py index 186733797..bd5c46d18 100644 --- a/notifications_utils/template.py +++ b/notifications_utils/template.py @@ -207,7 +207,7 @@ class BaseSMSTemplate(Template): # subclass, to avoid any HTML formatting. SMS templates differ # in that the content can include the service name as a prefix. # So historically we’ve returned the fully-formatted message, - # rather than some plain-text represenation of the content. To + # rather than some plain-text representation of the content. To # preserve compatibility for consumers of the API we maintain # that behaviour by overriding this method here. return SMSMessageTemplate.__str__(self)