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

Autolink declarations within declarations and fix self-linking #588

Merged
merged 36 commits into from
Jun 10, 2016

Conversation

jpsim
Copy link
Collaborator

@jpsim jpsim commented Jun 10, 2016

This is all @esad's work, I just fixed a few merge conflicts with master and rebuilt the integration specs.

Integration specs diff: realm/jazzy-integration-specs@3159385

@esad I suspect that this will hurt performance when generating the PSPDFKit docs since your API is pretty big and that the bulk of the time spent before this was in auto-linking IIRC. It might be worth focusing on performance improvements after this is merged.

esad and others added 30 commits April 6, 2016 11:25
…uped and ungrouped docs. Necessary for autolink to be able to correctly find enums.
…uped and ungrouped docs. Necessary for autolink to be able to correctly find enums.
…s equal, to prevent linking to the same page in certain cases.
…autolinking to different declarations on the same page
jpsim added 4 commits June 10, 2016 15:05
* master:
  use module name for dash keyword
  release 0.6.3
  Use SourceKitten's toolchain resolution if no Swift version is specified
  update integrate specs [ci skip]
  update integration specs
  don't document clang-unexposed Objective-C declarations
  allow danger to fail on CI
  update SourceKitten to 0.13.0
@jpsim jpsim mentioned this pull request Jun 10, 2016
!link_target.type.extension? &&
link_target.url &&
link_target.url != doc.url.split('#').first && # Don't link to parent
link_target.url != doc.url # Do not link to self
Copy link
Collaborator

@esad esad Jun 10, 2016

Choose a reason for hiding this comment

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

Arrrgh, can we have this be either both "Don't" or "Do not" for consistency (my OCD kicking in)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

lol, this is why everyone has love/hate relationships with code linters! I'll change the other one to "Don't" too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants