Deep audit: fill reachable fields and align docs - #2
Merged
Conversation
The mature flag on a stream, and the partner and affiliate flags on a searched channel, were declared on the records but never populated. All three come back fine from a logged-out GraphQL query, so they were dead columns rather than walled fields. Read broadcastSettings.isMature for streams and roles on channel search, and share one node selection between the top-stream and game-stream queries so a category's streams now show the category display name instead of backfilling the slug.
The site index and introduction still said "crawl" and "Twitch Interactive" while the README and tago.toml had settled on "read" and "Twitch", so make the wording match. Add markdown to the format list in the README and the quick start, where it was the only page missing it. The add-a-command guide pointed at a parse.go that does not exist; the wire-to-record mapping lives next to each query, so point at toClip in clips.go instead, and match the example op's summary and arg help to the real registration.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
A field-coverage and docs audit over every page type, record type, and field.
Source
Three record fields were declared but never filled, even though a logged-out GraphQL query returns all of them:
Stream.mature, now read frombroadcaster.broadcastSettings.isMature.Channel.partnerandChannel.affiliateon channel search, now read fromroles.The top-stream and game-stream queries now share one node selection, so a category's streams show the category display name instead of backfilling the slug. Removed two node fields that were selected but unused.
Tests updated: the top-streams fixture carries
isMature, search carriesroles, and both assert the new values.Docs
tago.tomlhad settled on "read" and "Twitch". Wording now matches across pages.markdownto the-oformat list in the README and the quick start, the only pages missing it.parse.gothat does not exist; it now points attoClipinclips.go, and the example op's summary and arg help match the real registration.Checks
gofmt, vet, test, and build are clean. The docs site builds (16 pages).