Expand HTTP driver docs#1016
Open
cerredz wants to merge 1 commit into
Open
Conversation
ad54f08 to
9fbe7ac
Compare
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
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.
/claim #851
Contributes to #851.
This adds another focused docs-revamp slice for
@cycle/http. It expands the HTTP API page with:select(), response metastreams, theresponse$.requestfield,flatten(), andflattenConcurrently()HTTPSource.filter()usageI also mirrored the Markdown content into the checked-in
docs/api/http.htmlwrapper because the docs generator is currently blocked in this checkout.Verification run locally:
node --check .scripts/make-api-docs.jsgit diff --checkdocs/content/api/http.mdanddocs/api/http.htmlI also tried regenerating the rendered API HTML with:
node .scripts/make-api-docs.js httpThat fails in the existing docs toolchain because the installed GitHub tarball for
doxthrowsTypeError: parse is not a function, matching the same pre-existing generator failure seen on the other docs-revamp branches.