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
Remove unecessary `` around LiveView and LiveComponent from docs #3240
base: main
Are you sure you want to change the base?
Conversation
Note that there is indeed a difference between LiveView wrapped in backticks and not. When wrapping it in backticks it links back to the specific module. So often when referring to LiveView in backticks one talks about the usage of the LiveView module instead of LiveView in general. So I’m not sure if this is actually correct. |
Hey, @SteffenDE. Thanks for your quick response.
I give it a try. It seems that the backlinks only work when we writes:
It doesn't work with:
I think that:
The scenario in the PR should be the first one. |
Good point with the backlinks only working with the full module name. I only wanted to point out that including the backticks could indeed be intentional. When in doubt, I’d wait for a comment from Chris or José. They wrote most of the changelog so they should know best :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
I agree with @c4710n's interpretation on where "LiveView" and "LiveComponent" refer to the general concept and not to a particular module or code reference.
lib/phoenix_component.ex
Outdated
When a `LiveView` is rendered, its contents are wrapped in a container. By default, | ||
the container is a `div` tag with a handful of `LiveView` specific attributes. | ||
When a LiveView is rendered, its contents are wrapped in a container. By default, | ||
the container is a `div` tag with a handful of LiveView specific attributes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the container is a `div` tag with a handful of LiveView specific attributes. | |
the container is a `div` tag with a handful of LiveView-specific attributes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated.
I found most of "LiveView" and "LiveComponent" in the doc is not wrapped by ``.
This PR:
Log
->log