-
Notifications
You must be signed in to change notification settings - Fork 131
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
sdoc-merge: badges don't appear anymore #71
Comments
@gamov Could you show me an example? |
hi @zzak, what kind of example would you like to see? html code snippet? A zip of a generated doc? |
What do you mean by "badges"? |
The 'Ruby' Badge (telling you from which doc is the item from): <li class="current"><h1><b>assert_equal</b><i>(exp, act, msg = nil)</i></h1><p>
<span class="badge badge_1">Ruby</span>
MiniTest::Assertions</p><p class="snippet">Fails unless <code>exp == act</code> printing the difference between the</p></li> The span is completely absent without my fix because it is simply not copied from the index. Generated from: ##
# Fails unless <tt>exp == act</tt> printing the difference between
# the two, if possible.
#
# If there is no visible difference but the assertion fails, you
# should suspect that your #== is buggy, or your inspect output is
# missing crucial details.
#
# For floats use assert_in_delta.
#
# See also: MiniTest::Assertions.diff
def assert_equal exp, act, msg = nil
msg = message(msg, "") { diff exp, act }
assert(exp == act, msg)
end |
@gamov I'm thinking of removing sdoc-merge in a future release of sdoc. If you can convince me we should fix this, and how to fix it; please let me know. |
Why |
@gamov Sorry for the late response! Yes, I have commit to RDoc, so this can be fixed upstream :) Please re-open if you have any issues! |
@gamov Can you try with rdoc master? Just add |
I don't use it within an app, but from the command line, this way:
Master triggered the following exception:
I have actually switched to Dash (https://kapeli.com/dash) for my documentation needs, it's great and merges in realtime. |
I had to add:
After line: https://github.com/rdoc/rdoc/blob/master/lib/rdoc/generator/template/json_index/js/searcher.js#L174
for the badges to appear.
Since this file doesn't below to this gem BUT this modification is needed for this gem to work properly, I'm not sure how to proceed.
The text was updated successfully, but these errors were encountered: