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 formatting for link to QualifiedName class in docs #480

Merged
merged 1 commit into from
Apr 28, 2021

Conversation

browniebroke
Copy link
Contributor

@browniebroke browniebroke commented Apr 27, 2021

Summary

While checking out the cods for the recently added FullyQualifiedNameProvider, I noticed that one link to a class wasn't properly handled by Sphinx:

image

I think the idea was to add an s at the end of the class name since we're talking about multiple of them, but I couldn't find how to make the s stick, so I've reworded a bit.

Alternative solutions I considered, with the reason why I didn't go for them:

  • Specify a title with the "s" (:class:`QualifiedNames <QualifiedName>`): altering the class name might confuse people
  • Add a space between the class name and the "s": formatting looks off
  • Remove extra markup/formatting: seems like a step back vs having links to the class docs.

Test Plan

Check the docs output

image

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Apr 27, 2021
@codecov-commenter
Copy link

Codecov Report

Merging #480 (54d3fe1) into master (3b21fa9) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #480   +/-   ##
=======================================
  Coverage   94.68%   94.68%           
=======================================
  Files         236      236           
  Lines       23013    23013           
=======================================
  Hits        21790    21790           
  Misses       1223     1223           
Impacted Files Coverage Δ
libcst/metadata/name_provider.py 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3b21fa9...54d3fe1. Read the comment docs.

Copy link
Member

@zsol zsol left a comment

Choose a reason for hiding this comment

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

Thanks for the fix!

@zsol zsol merged commit d1606b7 into Instagram:master Apr 28, 2021
@browniebroke browniebroke deleted the docs/qualified-name-class-link branch April 28, 2021 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants