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

[improvement] Handle @return description the same as @param description. #180

Closed
trusktr opened this issue May 16, 2016 · 2 comments
Closed

Comments

@trusktr
Copy link
Contributor

trusktr commented May 16, 2016

The .description value for an @param tag is a <ul>, but the .description for @return is a <p>, so they render differently even though the descriptions are the same format. This would make it easier for template parts be visually in unison. For example, in the screenshots the descriptions look different (the <ul> is indented, while the <p> isn't):

screen shot 2016-05-15 at 8 54 19 pm

@trusktr
Copy link
Contributor Author

trusktr commented May 16, 2016

For now, a simple workaround on my end is to wrap the HTML with a <ul class="description"> for @return tags:

ul.description p {
  display: list-item
}

Though the fix for this is probably easy, but gotta clone a repo, make PR, etc.. Maybe I can find some time later...

@trusktr
Copy link
Contributor Author

trusktr commented May 16, 2016

This may just be a subset of #181

@trusktr trusktr closed this as completed May 16, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant