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.

Sign up for GitHub

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

Jump to bottom

[docs] Fix link in UnsupportedOptimizationAttributes.rst. #31587

Merged
merged 1 commit into from
May 6, 2020
Merged

[docs] Fix link in UnsupportedOptimizationAttributes.rst. #31587

merged 1 commit into from
May 6, 2020

Conversation

dan-zheng
Copy link
Contributor

@dan-zheng dan-zheng commented May 6, 2020 •
edited
Loading

docs/TransparentAttr.rst was recently rewritten as docs/TransparentAttr.md: 00b46f3
Update old link to docs/TransparentAttr.rst.

Fixes Sphinx doc generation:

Warning, treated as error:
swift/docs/proposals/UnsupportedOptimizationAttributes.rst:18:undefined label: transparent-attribute (if the link has no caption the label must precede a section header)

@dan-zheng dan-zheng requested a review from CodaFi May 6, 2020 15:41
@dan-zheng
Copy link
Contributor Author

Note: the reference to docs/TransparentAttr.md doesn't show up pretty in .rst.

Screen Shot 2020-05-06 at 8 43 20 AM

I think that's okay though. If docs/proposals/UnsupportedOptimizationAttributes.rst gets rewritten to Markdown, it can link docs/TransparentAttr.md properly.

@dan-zheng
[docs] Fix link in UnsupportedOptimizationAttributes.rst.
4d1fc58 
docs/TransparentAttr.rst was recently rewritten as docs/TransparentAttr.md.
Update old link to docs/TransparentAttr.rst.

Fixes Sphinx doc generation.
@dan-zheng
Copy link
Contributor Author

@swift-ci Please smoke test

gottesmm
gottesmm approved these changes May 6, 2020
View reviewed changes
Copy link
Contributor

@gottesmm gottesmm left a comment

Choose a reason for hiding this comment

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

I am fine with this for now. We could also just refer to the blob of the readme (the perma GitHub address). Lets unbreak the build!

@dan-zheng dan-zheng merged commit c513cf1 into swiftlang:master May 6, 2020
@dan-zheng dan-zheng deleted the fix-docs branch May 6, 2020 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gottesmm gottesmm gottesmm approved these changes

@CodaFi CodaFi Awaiting requested review from CodaFi

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dan-zheng @gottesmm