Update Changelog, Docs and Error Message #153
Conversation
pulkitkkr
force-pushed
the
pulkitkkr_misc_updates_for_append_stylesheet_pack_tag
branch
from
1073953 to
b6f3114
Compare
README.md
Outdated
| @@ -284,8 +284,7 @@ Thus, you can distribute the logic of what packs are needed for any route. All t | |||
|
|
|||
| **Important:** `append_javascript_pack_tag` can be used anywhere in your application as long as it is executed BEFORE the `javascript_pack_tag`. If you attempt to call `append_javascript_pack_tag` helper after `javascript_pack_tag`, an error will be raised. You should have only a single `javascript_pack_tag` invocation in your page load. | |||
|
|
|||
| **Important** Similar to `append_javascript_pack_tag`, the `append_stylesheet_pack_tag` should be used anywhere in your application as long as it is executed BEFORE the `stylesheet_pack_tag`. However, if you attempt to call `append_stylesheet_pack_tag` helper after `stylesheet_pack_tag`, an error will be **NOT** be raised. | |||
|
|
|||
| **Important** Similar to `append_javascript_pack_tag`, the `append_stylesheet_pack_tag` should be used anywhere in your application as long as it is executed BEFORE the `stylesheet_pack_tag`. If you attempt to call `append_stylesheet_pack_tag` helper after `stylesheet_pack_tag`, an error will be raised. However, you may have multiple invocation of `stylesheet_pack_tag` | |||
There was a problem hiding this comment.
Now you have basically duplicate paragraphs one after another. Maybe combine them?
There was a problem hiding this comment.
True! We should merge them.
There was a problem hiding this comment.
To be honest, I wanted to recommend it already on the previous PR, but decided not to because of the apparent difference.
test/helper_test.rb
Outdated
| @@ -133,7 +133,7 @@ def test_append_javascript_pack_tag_raises | |||
|
|
|||
| assert_equal \ | |||
| "You can only call append_javascript_pack_tag before javascript_pack_tag helper. " + | |||
| "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#usage for the usage guide", | |||
| "Please refer to the documentation for append_javascript_pack_tag for more information.", | |||
There was a problem hiding this comment.
Where is this documentation, though? Do we have an API documentation page? (applies to all 3)
There was a problem hiding this comment.
Or did @justin808 just mean a more precise anchor, i.e. not https://github.com/shakacode/shakapacker/blob/master/README.md#usage but https://github.com/shakacode/shakapacker/blob/master/README.md#view-helpers-javascript_pack_tag-and-stylesheet_pack_tag?
There was a problem hiding this comment.
@alexeyr-ci1 we'll want to look into better organization of documentation in the future. We host the React on Rails documentation on our website: https://www.shakacode.com/react-on-rails/docs/
There was a problem hiding this comment.
So what do you guys suggest for now? Should we add the link to documentation page on Shakacode site?
There was a problem hiding this comment.
Right, this question is about what to do for now (though I've filed #154 while we were at it).
There was a problem hiding this comment.
So what do you guys suggest for now? Should we add the link to documentation page on Shakacode site?
It doesn't have these docs for now, I'd link to the correct README part.
There was a problem hiding this comment.
I will revert back to have the Links and just point to the correct location in README.md
There was a problem hiding this comment.
I bet we change the docs later and forget to update the error messages and tests.
There was a problem hiding this comment.
I mention it should be changed in #154 (comment).
justin808
deleted the
pulkitkkr_misc_updates_for_append_stylesheet_pack_tag
branch
This PR Addresses Docs, Error Messages and Changelogs-related Issues reported by @justin808 in #152 and #152