Documentation wanted: define_derived_metadata

[olleolleolle]

Subject of the issue

The define_derived_metadata configuration option could be easier to find.

The Relish-published docs of rspec-core mention it once, when describing Aggregate Failures.

This Issue is a request for more findable documentation. I hope this is the right forum for such a request.

Steps to reproduce

After I had solved my problem by web searching for things that sounded like it, I went to the relish site's search function. I pasted the correct term into the search box, and found next to nothing.

Expected behavior

A findable story about define_derived_metadata exists.

Where I would look: I would look under Metadata, or Configuration, for a named section, about derived metadata.

Actual behavior

A user can't learn about define_derived_metadata in that set of docs.

[benoittgt]

Hello @olleolleolle

Thanks for this issue. I am ok with this proposition. We should make https://relishapp.com/rspec/rspec-core/docs/expectation-framework-integration/aggregating-failures and especially define_derived_metadata more accessible.

[JonRowe]

If you'd like to tackle this @olleolleolle that would be great! We do have some er minimal documentation here http://rspec.info/documentation/3.8/rspec-core/RSpec/Core/Configuration.html#define_derived_metadata-instance_method

[ajn123]

@JonRowe is this issue still open, I am new. Can I take it ?

[JonRowe]

@ajn123 you're welcome to take a go