This repository was archived by the owner on Nov 24, 2025. It is now read-only.
Documentation cleanup #7798
Merged
Documentation cleanup #7798
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
ocket8888
added
bug
zrhoffman
approved these changes
Sep 27, 2023
Member
zrhoffman
left a comment
zrhoffman
left a comment
There was a problem hiding this comment.
Happy to merge this once the conflicts are fixed
tabs used for alignment, spaces used as indentation, etc.
Mostly this means the spacing and alignment in field lists, but also some of the fields got out of lexical order as well, and I ensured terminating newlines where they were missing
Mostly this relates to places where timestamps are incorrectly labeled as either RFC or non-RFC, but also includes an unnecessary versionadded directive, incorrect response types,
ocket8888
force-pushed
the
docs/cleanup
branch
from
3270425 to
5fb15fc
Compare
zrhoffman
approved these changes
Sep 28, 2023
rimashah25
pushed a commit
that referenced
this pull request
Jan 19, 2024
* Fix indentation and alignment errors tabs used for alignment, spaces used as indentation, etc. * trim trailing whitespace * Add missing admonitions for timestamp format changes * Fix formatting Mostly this means the spacing and alignment in field lists, but also some of the fields got out of lexical order as well, and I ensured terminating newlines where they were missing * Fix inaccurate/incorrect documentation Mostly this relates to places where timestamps are incorrectly labeled as either RFC or non-RFC, but also includes an unnecessary versionadded directive, incorrect response types, * Grammar fixes, add term links, add response field description * Fix bad automatic merge changes (cherry picked from commit e245f95)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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 addresses some issues with our API documentation. Its primary purpose, though, is to add in all of the
.. versionchanged::directives that are missing from fields that were changed in APIv5, namely: the fields that used to be non-RFC datetimes and are now in RFC3339 format.Other problems include:
Which Traffic Control components are affected by this PR?
What is the best way to verify this PR?
Make sure the docs build without any errors or warnings
If this is a bugfix, which Traffic Control versions contained the bug?
PR submission checklist