New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update v5 docs #384
Merged
Merged
Update v5 docs #384
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
This was referenced Mar 18, 2024
Merged
Merged
Merged
Merged
Merged
This was referenced Mar 23, 2024
Merged
Merged
Merged
Merged
Merged
Merged
This was referenced Apr 11, 2024
Merged
colincasey
force-pushed
the
v5-docs
branch
10 times, most recently
from
April 12, 2024 17:56
21bc575
to
ac1a471
Compare
Co-authored-by: Will Harney <62956339+wjhsf@users.noreply.github.com>
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 PR will be the staging area for multiple stacked PRs that update our API docs with markdown pages generated from TypeScript signatures +
@tsdoc
annotations. I'm introducing the API Extractor into our develop toolchain to handle this.The main landing page which is linked to from the README is here:
https://github.com/salesforce/tough-cookie/blob/v5-docs/api/docs/tough-cookie.md
And the README changes:
https://github.com/salesforce/tough-cookie/blob/v5-docs/README.md
The idea is to:
README.md
to be simpler since API docs can be moved to a dedicated areaNote
This PR will be marked as a draft until all the following child PRs in this stack have been reviewed and merged
getPublicSuffix
#385canonicalDomain
#386pathMatch
#387permuteDomain
#388cookieCompare
#390defaultPath
#391domainMatch
#393formatDate
#394parseDate
#395version
#396permutePath
#397PrefixSecurity
#398ParameterError
#399Cookie
#400CookieJar
#401Store
andMemoryStore
#402