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

Doc truncated after "Example:" #635

Closed
pcantrell opened this issue Aug 9, 2016 · 3 comments
Closed

Doc truncated after "Example:" #635

pcantrell opened this issue Aug 9, 2016 · 3 comments

Comments

@pcantrell
Copy link
Collaborator

The docs for this method:

https://github.com/bustoutsolutions/siesta/blob/1.0-beta.8/Source/ConfigurationPatternConvertible.swift#L36-L57

…get truncated in Jazzy’s output:

http://bustoutsolutions.github.io/siesta/api/Extensions/String.html#/s:FE6SiestaSS20configurationPatternFCS_7ServiceFCSo5NSURLSb

Xcode picks it all up correctly:

screen shot 2016-08-09 at 5 44 22 pm

I’m guessing that “Examples:” is the culprit.

@jpsim
Copy link
Collaborator

jpsim commented Nov 26, 2016

The link is now http://bustoutsolutions.github.io/siesta/api/Extensions/String.html#/s:FE6SiestaSS20configurationPatternFT3forCS_7Service_FV10Foundation3URLSb

and appears to render correctly:

image

Is this solved @pcantrell? Or did you work around the problem some other way?

@jpsim
Copy link
Collaborator

jpsim commented Nov 26, 2016

The source for the link seems to have an identical documentation comment as the original source link you shared: https://github.com/bustoutsolutions/siesta/blob/1.0.0/Source/Siesta/ConfigurationPatternConvertible.swift#L36-L57

So I'm assuming this has been fixed?

@johnfairh
Copy link
Collaborator

fixed!

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

No branches or pull requests

4 participants