Add documentation for "gold" Changemaker data #1300
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Without this commit, one would be left to read the source code to try to make sense of the values coming out of `GET /changemakers`. While source code may be well-commented, it does not capture the high-level intent that drove people to write it. This commit adds documentation with some details about the `/changemakers` endpoint and special attention to the method it uses to retrieve field values. Issue #1274
bickelj
force-pushed
the
add-data-conflicts-docs
branch
from
0c4c616
to
d88ff5b
Compare
|
Failed lint on a markdown file, wow. Thanks, |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1300 +/- ##
=======================================
Coverage 87.33% 87.33%
=======================================
Files 172 172
Lines 2258 2258
Branches 298 298
=======================================
Hits 1972 1972
Misses 261 261
Partials 25 25 ☔ View full report in Codecov by Sentry. |
hminsky2002
approved these changes
Nov 1, 2024
There was a problem hiding this comment.
To the extent that this explained our gold-data system to me just by reviewing it, cool! Approved, though I'd imagine @slifty and @jasonaowen should probably look through this first
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Without this commit, one would be left to read the source code to try to make sense of the values coming out of
GET /changemakers. While source code may be well-commented, it does not capture the high-level intent that drove people to write it. This commit adds documentation with some details about the/changemakersendpoint and special attention to the method it uses to retrieve field values.Issue #1274