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

Duplicate parameters, returns in docs #673

Closed
jdelaune opened this issue Nov 10, 2016 · 4 comments
Closed

Duplicate parameters, returns in docs #673

jdelaune opened this issue Nov 10, 2016 · 4 comments
Assignees
Labels

Comments

@jdelaune
Copy link

jdelaune commented Nov 10, 2016

Not sure if I'm formatting the docs wrong for jazzy or if there is something else going wrong. They look fine within Xcode. Here's what I have in code and this is what Jazzy produces.

Jazzy Duplicate Params

Turns into:

Jazzy Duplicate Params

Then also notice the floating = on the end.

Extra =

Extra =

Returns are also duplicating

Extra =

Extra =

Sorry for the jumbo images

@jdelaune jdelaune changed the title Duplicate parameters in docs Duplicate parameters, returns in docs Nov 10, 2016
@maddiemort
Copy link

I'm getting the same problem as well.

My code:
screen shot 2016-11-15 at 21 38 29

Jazzy output:
screen shot 2016-11-15 at 21 38 51

@jdelaune
Copy link
Author

So I've found out everything have to be lowercase and the parameters option isn't supported. You need individual parameter values.

@pigeon-archive
Copy link
Contributor

So I've found out everything have to be lowercase and the parameters option isn't supported. You need individual parameter values.

Closing.

@SDGGiesbrecht
Copy link
Contributor

This has been annoying me for a while. @istx25, you are correct that the problem is related to casing. However, Swift’s own API Design Guidelines use capitalized forms.

See here under “Write a documentation comment...”
    → “More Detail”
        → “Optionally, continue...”
            → “More Detail”

I’ve written a fix that will accept either case style. This is already the behaviour of the general callouts.

As soon as I get my files sorted out, I will submit a pull request.

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

No branches or pull requests

4 participants