Improve gem documentation #7
Conversation
README.md
Outdated
| ``` | ||
|
|
||
| `feature_helper` will also require `rails_helper` and `spec_helper`, | ||
| which can even be used standalone if needed. |
There was a problem hiding this comment.
We should also mention that the other helpers are requirable as well. And explain which helper is meant for what tests.
There was a problem hiding this comment.
I thought this part would explain that:
which can even be used standalone if needed
but I was probably wrong. I'll try to improve it further explaining what each helper is needed for.
kennyadsl
force-pushed
the
update-readme
branch
from
044d995 to
bfca837
Compare
kennyadsl
changed the title
|
@tvdeyen done an attempt to improve README following your suggestions. Let me know what do you think! |
README.md
Outdated
| correctly, setting up Capybara and configuring Rails test application | ||
| to precompile assets before the first feature spec. | ||
|
|
||
| To run, this helper needs to require a `rails_helper`, also provided by |
There was a problem hiding this comment.
To run, this helper needs to require a, also provided byrails_helper
This helper requires the rails_helper, also provided by ...
README.md
Outdated
| like authorization helpers, Solidus core factories, url helpers, and | ||
| other helpers to easily work with Solidus Config. | ||
|
|
||
| This `rails_helper` in turn requires a basic `spec_helper`, which is |
There was a problem hiding this comment.
This
rails_helperinturn requires abasicspec_helper, which is
This rails_helper in return requires the basic spec_helper, which is
There was a problem hiding this comment.
I know I can be wrong here but I think in turn here is correct. 😄 🇬🇧
There was a problem hiding this comment.
I am also not sure. Leave it as it is then :)
kennyadsl
force-pushed
the
update-readme
branch
from
bfca837 to
01415a8
Compare
This PR just adds a section in the README that explains how to use new testing helpers for extensions.
It also removes
.rbextensions form code documentation requires.