Docs/spec polish follow-ups from the facade flatten#151
Merged
Conversation
- Restore the search/3 doc note that a URL query makes Mastodon attempt to fetch the account or status, and the vote/3 note that multiple choices are only allowed on multiple-choice polls. - Restore the pre-flatten clarifying summary lines on accept_notification_request/2 and dismiss_notification_request/2, and give dismiss_notification_requests/2 the parallel clause. - Tighten @SPEC blocked_domains/2 to :: [String.t()]. - Remove the unreachable process_request_body(data) when is_binary(data) clause: no endpoint passes a raw binary body since the flatten. Fixes #139 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
Fixes #139 — all four polish items that fell out during the 0.7.0 facade flatten (#137, #138). No behavior changes.
search/3/vote/3doc notes restored: the pre-flattenHunter.Result.searchclause ("ifqis a URL Mastodon will attempt to fetch the provided account or status, otherwise it will do a local account and hashtag search") and theHunter.Poll.voteclause ("multiple choices are only allowed on multiple-choice polls") are back on the facade docs, recovered frome4c0f14~1.accept_notification_request/2("…so future notifications from the account are delivered normally") anddismiss_notification_request/2("…removing it and its filtered notifications") get their pre-flatten wording back verbatim;dismiss_notification_requests/2never had a clarifying clause in the entity module, so it gets the parallel plural one ("…removing them and their filtered notifications").@spec blocked_domains/2tightened from:: listto:: [String.t()](the endpoint returns bare domain strings), continuing Typespec honesty: string entity ids, true booleans #135/Typespec honesty: entity ids typed non_neg_integer but Mastodon returns strings #116.process_request_body(data) when is_binary(data)inlib/hunter/api/request.ex— audited all write-verbRequest.request!call sites; every payload is a map, keyword list, or{:form_multipart, parts}, so the raw-binary clause is unreachable since the flatten.Verification
mix test(2 doctests, 245 tests, 0 failures),mix credo --strict,mix dialyzer,mix docs, andmix format --check-formattedall clean.🤖 Generated with Claude Code