Skip to content
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

Better example display #595

Open
wants to merge 40 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
a310716
Updated bootstrap css and js.
Haniyya Dec 28, 2017
6538620
Added initializer for bootstrap stuff.
Haniyya Jan 4, 2018
08528e2
Split off example display into different partial.
Haniyya Jan 4, 2018
3ab4763
Stopped apipie from pre formating params info.
Haniyya Jan 4, 2018
03fa430
Added collapsible behaviour.
Haniyya Jan 15, 2018
ae68f7e
Passed index to example display.
Haniyya Jan 15, 2018
382d498
Expanded the scope of the recorded params and propagated them through…
Haniyya Jan 16, 2018
35a6934
Added new request_data_json field to file filtering.
Haniyya Jan 16, 2018
ccf11fd
Added new field to example formating.
Haniyya Jan 16, 2018
f8c696f
Added more descriptive example titles.
Haniyya Jan 16, 2018
0859d80
Added doc_title to let you record titles in the examples.
Haniyya Jan 16, 2018
a3fa129
Removed obsolete js.
Haniyya Jan 16, 2018
a85ac0e
Setup panel structure in Resource description.
Haniyya Jan 16, 2018
23fde37
Wrapped method desciption in a panel-body.
Haniyya Jan 16, 2018
be6a16d
Cleaned up example partial and added more toggles.
Haniyya Jan 16, 2018
11c1d2c
Fixed a css issue caused by bootstrap.
Haniyya Jan 16, 2018
1f6c600
Made the code snippets more readable.
Haniyya Jan 16, 2018
2a835f0
Changed specification for example loading as they are no longer pre-f…
Haniyya Jan 16, 2018
b60b867
Added an alternative templates for pure string examples.
Haniyya Jan 17, 2018
5b9a7ce
Added doc_title to recorder.
Haniyya Jan 17, 2018
d563ee8
Added doc title to writer.
Haniyya Jan 17, 2018
a996c54
Split off example display into different partial.
Haniyya Jan 4, 2018
9b5e735
Stopped apipie from pre formating params info.
Haniyya Jan 4, 2018
aed8772
Expanded the scope of the recorded params and propagated them through…
Haniyya Jan 16, 2018
2fc0626
Added new request_data_json field to file filtering.
Haniyya Jan 16, 2018
7c799b1
Added new field to example formating.
Haniyya Jan 16, 2018
1d91ac1
Added more descriptive example titles.
Haniyya Jan 16, 2018
530b131
Changed specification for example loading as they are no longer pre-f…
Haniyya Jan 16, 2018
352157e
Added an alternative templates for pure string examples.
Haniyya Jan 17, 2018
289e840
Merge branch 'feature/rspec_doc_title' into feature/better-example-di…
Haniyya Jan 17, 2018
0d4be81
Merge branch 'feature/request_data_json' into feature/better-example-…
Haniyya Jan 17, 2018
297a260
Added doc_title description to readme.
Haniyya Jan 17, 2018
f2c5b51
Empty commit to trigger travis build.
Haniyya Jan 18, 2018
00cea1c
Merge branch 'feature/rspec_doc_title' into feature/better-example-di…
Haniyya Jan 18, 2018
f221c3c
Updated jQuery, removed unnecessary files from Apipie.include_javascr…
stex Jan 22, 2018
8ab092e
Merge branch 'feature/bootstrap-update' into feature/better-example-d…
Haniyya Jan 22, 2018
0184198
Merge pull request #3 from lokalportal/feature/bootstrap-update
stex Jan 22, 2018
cb37150
Updated a helper method to fit bootstrap3s labels.
Haniyya Jan 24, 2018
265be6a
Added a chance for warning labels to have their place.
Haniyya Jan 24, 2018
fb4b100
Merge branch 'feature/bootstrap-update' into feature/better-example-d…
Haniyya Jan 24, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1401,6 +1401,19 @@ And then configure RSpec in this way:
This way, when running in recording mode, only the tests that have been marked with the
``:show_in_doc`` metadata will be run, and hence only those will be used as examples.

If you want to distinguish your recorded examples from one another, you can provide a ``doc_title``
that will be displayed in the documentation later, like this:

.. code:: ruby

it 'works', :show_in_doc, doc_title: 'A working example' do
expect_it.to work
end

it 'wont work', :show_in_doc, doc_title: 'A failing example' do
expect_it.not_to work
end

Caveats
-------

Expand Down
2 changes: 1 addition & 1 deletion app/public/apipie/javascripts/apipie.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ $(document).ready(function() {
$('pre.ruby').addClass('prettyprint lang-rb');
prettyPrint();
}
});
});
138 changes: 0 additions & 138 deletions app/public/apipie/javascripts/bundled/bootstrap-collapse.js

This file was deleted.

Loading