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

Unify desc format for SVG elements #36883

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

skyclouds2001
Copy link
Contributor

Description

Motivation

Additional details

Related issues and pull requests

@skyclouds2001 skyclouds2001 marked this pull request as ready for review November 20, 2024 15:51
@skyclouds2001 skyclouds2001 requested a review from a team as a code owner November 20, 2024 15:51
@skyclouds2001 skyclouds2001 requested review from hamishwillee and removed request for a team November 20, 2024 15:51
@github-actions github-actions bot added Content:SVG SVG docs size/m [PR only] 51-500 LoC changed labels Nov 20, 2024
Copy link
Contributor

Preview URLs (40 pages)
External URLs (2)

URL: /en-US/docs/Web/SVG/Element/feColorMatrix
Title: <feColorMatrix>


URL: /en-US/docs/Web/SVG/Element/vkern
Title: <vkern>

@bsmth bsmth requested a review from pepelsbey November 20, 2024 15:53
@bsmth
Copy link
Member

bsmth commented Nov 20, 2024

Thanks for this! I'm going to anticipate that Hamish will suggest also updating the SVG element page template to be explicit about this if we're going ahead with this format. I've updated the HTTP header template page with a quote block with how we expect the first sentence should look if you want to use that for inspiration.

edit: also adding in Pepelsbey who might have opinions on the SVG intro format :)

@@ -7,7 +7,7 @@ browser-compat: svg.elements.textPath

{{SVGRef}}

To render text along the shape of a {{SVGElement("path")}}, enclose the text in a **`<textPath>`** element that has an {{SVGAttr("href")}} attribute with a reference to the {{SVGElement("path")}} element.
To render text along the shape of a {{SVGElement("path")}}, enclose the text in a **`<textPath>`** [SVG](/en-US/docs/Web/SVG) element that has an {{SVGAttr("href")}} attribute with a reference to the {{SVGElement("path")}} element.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This one doesn't look very consistent. Can it be reworded?

@@ -7,7 +7,7 @@ browser-compat: svg.elements.a

{{SVGRef}}

The **\<a>** SVG element creates a hyperlink to other web pages, files, locations in the same page, email addresses, or any other URL. It is very similar to HTML's {{htmlelement("a")}} element.
The **`<a>`** [SVG](/en-US/docs/Web/SVG) element creates a hyperlink to other web pages, files, locations in the same page, email addresses, or any other URL. It is very similar to HTML's {{htmlelement("a")}} element.
Copy link
Collaborator

Choose a reason for hiding this comment

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

HOw did you decide on this pattern? I ask because HTTP went the other way - such as

The HTTP Last-Modified ...

I have no problem with this, just interested in the thinking.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:SVG SVG docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants