docs: name the parameters these two blocks describe - #5735
Open
darkdi wants to merge 1 commit into
Open
Conversation
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.
This relates to...
Nothing filed, I ran into it while reading the cache store.
Rationale
MemoryCacheStore.getdocuments its argument asreq, while the method takeskeyand the two neighbours in the same class,createWriteStreamanddelete, both documentkey. The webidl one is the more confusing of the two:webidl.errors.exceptiondocumentsopts,opts.headerandopts.message, but the parameter is calledmessageand the body readsmessage.headerandmessage.message, so the documented name collides with a field name. Its two siblings,conversionFailedandinvalidArgument, name the bagoptsandcontextand document exactly that.Changes
Comments only, no runtime change.
Features
N/A
Bug Fixes
N/A
Breaking Changes and Deprecations
N/A
Status