rspec_api_documentation icon indicating copy to clipboard operation
rspec_api_documentation copied to clipboard

What is difference between docs:generate:ordered & docs:generate ?

Open pramodshinde opened this issue 9 years ago • 5 comments

Hello, Scenario 1:

config.keep_source_order = false

I tried

rake docs:generate
rake docs:generate:ordered 

For both above commands same documented is getting generated i.e ordered by description Scenario 2:

config.keep_source_order = true

I tried

rake docs:generate
rake docs:generate:ordered 

For both above commands same documented is getting generated i.e ordered by source

In both scenario I can't find any difference between rake docs:generate:ordered & rake docs:generate, Am I missing something here?

pramodshinde avatar Dec 17 '15 19:12 pramodshinde

@pramodshinde I read Rake Task(https://github.com/zipmark/rspec_api_documentation#rake-task) section of README and I can only see

$ rake docs:generate

Can you point out where you read docs for rake docs:generate:ordered ?

anilmaurya avatar Dec 20 '15 19:12 anilmaurya

The rake docs:generate:ordered task is here. I think the problem may have started when we switched to rspec 3, someone just did a PR fixing the ordered task, #245.

oestrich avatar Dec 20 '15 19:12 oestrich

Docs should be updated with available options.

anilmaurya avatar Dec 21 '15 05:12 anilmaurya

@anilmaurya Yes ultimately I wanted to update docs to include both tasks, before that I tested both tasks I did not find any difference between above mentioned tasks, So wanted confirm is there any difference or its an issue?

pramodshinde avatar Dec 21 '15 08:12 pramodshinde

With the new version (4.7.0) does this still happen. It has PR #245 merged.

oestrich avatar Feb 01 '16 20:02 oestrich