Skip to content
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

Fix links and code edge cases in docs generation #2896

Merged
merged 3 commits into from Mar 27, 2023

Conversation

jonemo
Copy link
Contributor

@jonemo jonemo commented Mar 27, 2023

Fixes two classes of errors that were introduced in #2855:

  • When link text starts with a space, the link no longer gets rendered correctly. This one was discovered by @nateprewitt
  • Preformatted and code snippets that contain stylized quotation marks () instead of plain ".

As part of investigating this, I found that the special treatment for trailing whitespace in data nodes (where one whitespace is always left behind) is another special case whitespace treatment longer needed and removed it.

Examples

Before

Screenshot 2023-03-27 at 10 02 19 AM

After

Screenshot 2023-03-27 at 10 02 35 AM

Before

Screenshot 2023-03-27 at 9 04 57 AM

After

Screenshot 2023-03-27 at 9 05 04 AM

Before

Screenshot 2023-03-27 at 9 16 53 AM

After

Screenshot 2023-03-27 at 9 16 57 AM

Testing

Spot checked HTML of ~200 pages with diffs from the changes in this PR. All of them are either fixes of the issues described above, or further removals of unnecessary whitespace.

@codecov-commenter
Copy link

codecov-commenter commented Mar 27, 2023

Codecov Report

Patch coverage: 85.71% and no project coverage change.

Comparison is base (bd42779) 93.58% compared to head (2ffe66e) 93.59%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2896   +/-   ##
========================================
  Coverage    93.58%   93.59%           
========================================
  Files           63       63           
  Lines        13516    13517    +1     
========================================
+ Hits         12649    12651    +2     
+ Misses         867      866    -1     
Impacted Files Coverage Δ
botocore/docs/bcdoc/docstringparser.py 99.42% <80.00%> (+0.56%) ⬆️
botocore/docs/bcdoc/style.py 95.20% <100.00%> (+0.03%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Contributor

@nateprewitt nateprewitt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jonemo jonemo merged commit 6bf947d into boto:develop Mar 27, 2023
31 checks passed
@jonemo jonemo deleted the docs-whitespace-fix-1 branch March 27, 2023 21:22
aws-sdk-python-automation added a commit that referenced this pull request Mar 28, 2023
* release-1.29.101:
  Bumping version to 1.29.101
  Update to latest partitions and endpoints
  Update to latest models
  Fix links and code edge cases in docs generation (#2896)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants