Using show_in_doc

[Nerian]

Hello,

I am not sure how to use the show_in_doc option.

My first thought was that it was metadata for an example, like:

    context "With correct credentials", :show_in_doc => true do
      it "Can authenticate" do
        ....
      end
    end

    context "with incorrect credentials", :show_in_doc => false do
      it "Can't authenticate" do
          ....
      end
    end

But this doesn't seems to have any effect.

Can you give an example?

[Nerian]

I ended up doing this in spec_helper.rb

RSpec.configure do |config|
   config.filter_run :show_in_doc => true if ENV['APIPIE_RECORD']
end

[iNecas]

Hi,

The show_in_doc now is an attribute that can be find directly in the generated doc/apipie_examples.yml, so you can tweak the output somehow there.

I like your approach. Feel free to add this tip into the README and send PR (I can do it, but the authorship information will be lost :)

[Nerian]

Sure thing. Pull request sent :)

[iNecas]

I believe we can close the issue then. Thanks for contribution