Allow docs to be generated in separate class from target #252
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Please update CHANGELOG, fix the build and squash the commits ( |
|
@dblock Done. Rubocop made a bunch of random code changes, and forced me to refactor for length as well. So, fair warning, this is now merge conflict bonanza. |
| def as_markdown(description) | ||
| description && @@markdown ? @@markdown.as_markdown(strip_heredoc(description)) : description | ||
| end | ||
| module GrapeSwaggerDocMethods |
There was a problem hiding this comment.
Can we pull this one out into its own file?
|
Looks good, see my comment above and please squash these commits, too. |
Fixes the `target_class` option to fully work. The code structure here is highly questionable (no separation of concerns, for one thing). But the whole class needs some serious refactoring, so this will work until that happens, at least.
The class finally tipped the scales and Rubocop didn't like that. This is a quick fix until some more substantial refactoring takes place.
iangreenleaf
force-pushed
the
mount_separately
branch
from
e8e808e to
9973c7c
Compare
|
Ok, pulled the module out and squashed. I didn't squash the Rubocop refactoring, since those commits are totally unrelated to the actual change. That okay with you? |
|
This looks great, merging. |
dblock
added a commit
that referenced
this pull request
May 1, 2015
Allow docs to be generated in separate class from target
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I think this is the intention of the
target_classoption—to allow the docs for an API class to be generated in a different class. The existing implementation didn't support the full split, so I did a quick fix to change that. You can take a look at the spec I added to check that my understanding of the desired behavior is correct.