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

Update documentation in asset_tag_helper.rb [ci-skip] #49957

Merged
merged 1 commit into from Nov 7, 2023

Conversation

gjtorikian
Copy link
Contributor

Just a wee bit of visualization changes to make it more explicitly clear what is being passed (a quoted number).

I found the lack of visualization on the docs site a bit hard to understand.

@rails-bot rails-bot bot added the actionview label Nov 7, 2023
Copy link
Member

@jonathanhefner jonathanhefner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These seem like nice improvements. 👍 However, usage of + in RDoc is limited to name-like strings. For example you can write +foobar+, but not +foo bar+. Instead, you must write <tt>foo bar</tt>.

I believe all strings you've marked up here must use <tt> due to including either whitespace or other punctuation marks.

actionview/lib/action_view/helpers/asset_tag_helper.rb Outdated Show resolved Hide resolved
actionview/lib/action_view/helpers/asset_tag_helper.rb Outdated Show resolved Hide resolved
@jonathanhefner jonathanhefner changed the title Update documentation in asset_tag_helper.rb Update documentation in asset_tag_helper.rb [ci-skip] Nov 7, 2023
@gjtorikian
Copy link
Contributor Author

Ah! I had originally gone through and added backticks to them, then simply copied the + from elsewhere in those docs. Thanks for your fixes!

Just a wee bit of visualization changes to make it more explicitly clear what is being passed (a quoted number)

Co-authored-by: Jonathan Hefner <jonathan@hefner.pro>
@jonathanhefner jonathanhefner merged commit 253cddd into rails:main Nov 7, 2023
3 checks passed
@jonathanhefner
Copy link
Member

I pushed a commit to squash the commits.

Thank you, @gjtorikian! 📜

jonathanhefner added a commit that referenced this pull request Nov 7, 2023
Update documentation in asset_tag_helper.rb [ci-skip]

(cherry picked from commit 253cddd)
jonathanhefner added a commit that referenced this pull request Nov 7, 2023
Update documentation in asset_tag_helper.rb [ci-skip]

(cherry picked from commit 253cddd)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants