Repository navigation
Raise the Request/Response Syntax doc section limit to 2,000 lines - #3823
Merged
Merged
Conversation
On develop, MediaLive's Channel operations produce Response Syntax sections of 1,589 to 1,591 lines and Request Syntax sections of 1,580 (CreateChannel) and 1,568 lines (UpdateChannel). The 1,500-line limit from #2839 replaces all ten with the "too large to render" notice, and those blocks are where the reference shows the allowed enum values. Raise the two syntax-section limits to 2,000 lines. By the section sizes listed in #2839, the smallest syntax section above 2,000 lines is 2,036 (wafv2), so the oversized sections it cut stay cut; one lexv2-models section at 1,778 lines renders again. The 5,000-line limit on Parameters and Response Structure is unchanged. Add unit tests for a section at the limit, one line over it, and the limit value.
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Copilot review overview
2 open findings
What changed in this PR
Raises the generated documentation rendering thresholds so large MediaLive Channel Request/Response Syntax sections render instead of being replaced by a “too large to render” notice.
Changes:
- Increase Request Syntax and Response Syntax line limits from 1,500 to 2,000.
- Add unit tests covering “at limit”, “over limit”, and asserting the new configured limit value.
- Add a documentation enhancement changelog entry.
| File | Description |
|---|---|
botocore/docs/bcdoc/restdoc.py |
Bumps syntax section line limits to 2,000 lines via SECTION_LINE_LIMIT_CONFIG. |
tests/unit/docs/bcdoc/test_document.py |
Adds tests to ensure syntax sections are kept/replaced at the new limits. |
.changes/next-release/enhancement-Documentation-8bbb1803.json |
Records the doc rendering limit increase in release notes. |
🧠 Review effort: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+85
to
+92
| self.assertIn(b'\n%d\n' % (limit - 1), contents) | ||
|
|
||
| def test_syntax_section_over_line_limit_is_replaced(self): | ||
| limit = SECTION_LINE_LIMIT_CONFIG['response-example']['line_limit'] | ||
| contents = self._flush_syntax_section('response-example', limit + 1) | ||
| self.assertIn(b'too large to render', contents) | ||
| self.assertIn(b'**Response Syntax**', contents) | ||
| self.assertNotIn(b'\n%d\n' % limit, contents) |
Copilot stopped reviewing on behalf of
AlexDaines due to an error
October 13, 2026 23:53
jonathan343
approved these changes
Oct 14, 2026
Alan4506
pushed a commit
that referenced
this pull request
Oct 14, 2026
* release-1.43.114: Bumping version to 1.43.114 Update endpoints model Update to latest models Raise the Request/Response Syntax doc section limit to 2,000 lines (#3823)
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.
On develop, MediaLive's Channel operations produce Response Syntax sections of 1,589 to 1,591 lines (CreateChannel, UpdateChannel, UpdateChannelClass, RestartChannelPipelines, DeleteChannel, DescribeChannel, StartChannel, StopChannel) and Request Syntax sections of 1,580 lines (CreateChannel) and 1,568 lines (UpdateChannel). The 1,500-line limit from #2839 replaces all ten with the "too large to render" notice. Those blocks are where the reference shows the allowed enum values, for example
'AfdSignaling': 'AUTO'|'FIXED'|'NONE'; the Parameters and Response Structure entries give each field's type and description without its values.This raises the two syntax-section limits to 2,000 lines. Generating the MediaLive pages on develop gives ten notices at 1,500 and none at 2,000. By the section sizes listed in #2839 (December 2022), the smallest syntax section above 2,000 lines is 2,036 (wafv2), so the oversized sections it cut stay cut; one lexv2-models section at 1,778 lines renders again. The 5,000-line limit on Parameters and Response Structure is unchanged. MediaLive's Channel Response Structure sections are at 4,178 to 4,182 lines and the CreateChannel Parameters section at 4,108, so the Channel model may reach that limit later. A per-service limit would need the service name on the section path, which the per-method pages do not carry today, so this PR does not add one.
Unit tests cover a section at the limit (kept), one line over the limit (replaced), and the limit value.