Re:I'd like to review your README
by nooyurrsdey on Saturday April 17, 2021 @08:23AM
(#26843733)
prism.js the code syntax highlighter is notoriously bad at this.
At first I felt bad for being confused by something so simple. But all their code examples for highlighting refer to their own code and you're right, at the exact moment you're trying to absorb new information it is infuriating to deal with the "meta" examples.
I don't use them out of that alone.
This is my main issue with Rspec documentation.
RSpec has none of that, a typical example from the first page of their documentation:
RSpec.describe Widget do
example do
expect(described_class).to equal(Widget)
end
end
As a reader unfamiliar with a project, it's unpleasant to have to contend with "meta" at a time when one doesn't even have a solid first-order understanding of the project.