darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-09-09 17:45:32 -04:00
Code Issues Packages Projects Releases Wiki Activity

Clean up typos

Browse Source 
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 <carlo.costino@gsa.gov>
This commit is contained in:
Carlo Costino
2025-05-21 17:01:01 -04:00
parent 45b4cdac56
commit 206247f543
11 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -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.

2
docs/docker-remote-containers.md
View File

@@ -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.

2
docs/feature-flagging.md
View File

@@ -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

6
docs/sprint-goals.md
View File

@@ -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

2
notifications_utils/clients/redis/redis_client.py
View File

@@ -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

2
notifications_utils/formatters.py
View File

@@ -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, "")

4
notifications_utils/insensitive_dict.py
View File

@@ -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

4
notifications_utils/international_billing_rates.yml
View File

@@ -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

2
notifications_utils/recipients.py
View File

@@ -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)

2
notifications_utils/serialised_model.py
View File

@@ -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

2
notifications_utils/template.py
View File

@@ -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)