Skip to content

Commit 69b841e

Browse files
authored
[Issue #18] Updates answers to spec design questions (#44)
Fixes typos in the following ADRs: - v0.1.0 models and routes - Monetary fields
1 parent 4c4b794 commit 69b841e

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

website/src/content/docs/decisions/adr/0007-initial-models-and-routes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ We'll limit the scope of the v0.1.0 protocol to the models and routes needed to
2222
- Lays the foundation for expansion in subsequent versions.
2323
- **Negative consequences**
2424
- Will require future updates to accommodate additional models and operations.
25-
- Could limit initial functionality for specific advanced use cases, such as post-award reporting.
25+
- Doesn't (yet) support key features like applications and reporting.
2626
- May be harder to make changes once platforms have started adopting the protocol.
2727

2828
### Decision drivers
@@ -39,12 +39,12 @@ We'll limit the scope of the v0.1.0 protocol to the models and routes needed to
3939
1. **Base types:** Includes essential reusable fields such as currency, GeoJSON, and custom fields.
4040
2. **Grant opportunity models:** Models describing the metadata for grant opportunities.
4141
3. **Individuals and organizations:** Basic models for describing grantors and grant seekers.
42-
4. **Application forms and submissions:** Models describing application processes and submission structures.
42+
4. **Application forms and submissions:** Models describing application forms and submissions.
4343
5. **Grant awards and reporting:** Models for tracking awarded grants and reporting requirements.
4444

4545
#### Operations
4646

47-
1. Searching and viewing opportunities\*\*
47+
1. Searching and viewing opportunities
4848
2. Saving or subscribing to opportunities
4949
3. Managing organization membership
5050
4. Filling out and submitting applications
@@ -90,7 +90,7 @@ Also include models and routes needed to support filling out and submitting appl
9090
- **Cons**:
9191
- Increases implementation complexity.
9292
- Application processes can vary significantly by platform and grant.
93-
- Might be hard to land on a common standard in time for v0.1.0
93+
- Might be hard to align on a common standard in time for v0.1.0.
9494

9595
### Option 4: Also support post-award reporting
9696

website/src/content/docs/decisions/adr/0009-monetary-fields.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Here's an example of that format:
6464

6565
### Option 1: Floating point
6666

67-
Monetary values are represented as strings with fixed decimal points (e.g., `1234.56` for $1234.56).
67+
Monetary values are represented as a floating point number (e.g., `1234.56` for $1234.56).
6868

6969
- **Pros**
7070
- Human-readable and easier for API consumers to debug.
@@ -76,13 +76,13 @@ Monetary values are represented as strings with fixed decimal points (e.g., `123
7676

7777
### Option 2: Decimal string
7878

79-
Monetary values are represented as strings with fixed decimal points (e.g., `"1234.56"` for $1234.56).
79+
Monetary values are represented as a string-formatted decimal value (e.g., `"1234.56"` for $1234.56).
8080

8181
- **Pros**
8282
- Human-readable and easier for API consumers to debug.
8383
- No conversion required for display or consumer-facing applications.
8484
- Suitable for currencies with non-standard subunits (e.g., cryptocurrencies).
85-
- Commonly used format for monetary values, e.g. PayPal, ApplePay, etc.
85+
- Commonly used format for monetary values, e.g., PayPal, Apple Pay, Google Pay, etc.
8686
- **Cons**
8787
- Vulnerable to floating-point precision issues if parsed into floating-point numbers.
8888
- Parsing and validation of string inputs are more complex than integers.
@@ -97,7 +97,7 @@ Monetary values are represented as integers in the smallest unit of the currency
9797
- Ideal for aggregation, sorting, and other arithmetic operations.
9898
- Compact representation (smaller payloads compared to string decimals).
9999
- Consistent format across implementations.
100-
- Commonly used format for monetary values, e.g. Stripe, Square.
100+
- Commonly used format for monetary values, e.g., Stripe, Square, etc.
101101
- **Cons**
102102
- Less human-readable than string representations.
103103
- Requires explicit documentation of smallest unit conventions (e.g., cents for USD, yen has no subunit).

0 commit comments

Comments
 (0)