KEMBAR78
[FIX] Docs sequence for BracesAroundHashParameters by roolo · Pull Request #4870 · rubocop/rubocop · GitHub
Skip to content

Conversation

@roolo
Copy link
Contributor

@roolo roolo commented Oct 16, 2017

Code examples for each list item appeared all under the list, instead of having each code example
under the coresponding list item.

These changes does not influence any functionality, hence there is no changelog entry, spec .

master-vs-docs-sequence-for-braces-around-hash-parameters

Code examples for each list item appeared all under the list, instead of having each code example
under the coresponding list item.
@bbatsov
Copy link
Collaborator

bbatsov commented Oct 17, 2017

Won't giving names to the examples also fix this?

P.S. You also have to regenerate the manual.

@roolo roolo force-pushed the docs-sequence-for-braces-around-hash-parameters branch from bc46d7f to e9b9e6a Compare October 17, 2017 10:21
@roolo
Copy link
Contributor Author

roolo commented Oct 17, 2017

RE @bbatsov -- #4870 (comment)

Sry, just forgot to push the regeneration of manual.

What do you mean by giving names? Like @example <Content of list item>? I think here are the options https://gitter.im/lsegal/yard?at=59e530ea32e080696eeb2e38

@bbatsov
Copy link
Collaborator

bbatsov commented Oct 17, 2017

Ah, that's a good point. Generally we've been using @example quite often for things which are not really API examples....

@bbatsov bbatsov merged commit 110e28c into rubocop:master Oct 17, 2017
@bbatsov
Copy link
Collaborator

bbatsov commented Oct 17, 2017

👍

@roolo roolo deleted the docs-sequence-for-braces-around-hash-parameters branch May 9, 2018 16:28
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

Successfully merging this pull request may close these issues.

2 participants