Skip rendering empty descriptions #355
Merged
Conversation
This file contains 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
`RDoc::CodeObject#comment` appears to always return a string, even if no comment has been specified. Thus the truthiness of `comment` cannot be used to skip rendering empty descriptions. This commit adds a `description_for` helper to encapsulate properly checking `comment` and wrapping the rendered description in a `div`. This commit also renames the `full_name` and `short_name` helpers to `full_name_for` and `short_name_for` to match `description_for`.
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.
RDoc::CodeObject#commentappears to always return a string, even if no comment has been specified. Thus the truthiness ofcommentcannot be used to skip rendering empty descriptions.This commit adds a
description_forhelper to encapsulate properly checkingcommentand wrapping the rendered description in adiv.This commit also renames the
full_nameandshort_namehelpers tofull_name_forandshort_name_forto matchdescription_for.