add: SVG Angle MDN Feature Pages

[yashrajbharti]

Description

This PR adds the MDN feature pages for the SVGAngle interface as part of a recent project to document missing Widely available pages for interface features.

Motivation

I believe that my support in documenting the SVGAngle interface can significantly help developers by providing essential resources.

Additional details

For more context, see the discussion on missing documentation tracked at https://openwebdocs.github.io/web-docs-backlog/baseline/. Additionally, related projects for adding widely available web features can be found at openwebdocs/project#214.

Related issues and pull requests

Relates to #214

[github-actions]

Preview URLs (7 pages)

• /en-US/docs/Web/API/SVGAngle/convertToSpecifiedUnits
• /en-US/docs/Web/API/SVGAngle/newValueSpecifiedUnits
• /en-US/docs/Web/API/SVGAngle/unitType
• /en-US/docs/Web/API/SVGAngle/valueAsString
• /en-US/docs/Web/API/SVGAngle/valueInSpecifiedUnits
• /en-US/docs/Web/API/SVGAngle/value
• /en-US/docs/Web/API/SVGAngle

Flaws (2)

Note! 6 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/SVGAngle
Title: SVGAngle
Flaw count: 2

• macros:
  • /en-US/docs/Web/API/SVGSVGElement/createSVGAngle does not exist
  • /en-US/docs/Web/API/SVGSVGElement/createSVGAngle does not exist

(comment last updated: 2025-01-07 16:53:23)

[wbamberg]

Thanks for your PR!

Please review the templates we use for reference pages: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Page_structures/Page_types#api_reference_subpage and be sure to follow them. If you have any questions about specific aspects of the templates, please feel free to ask.

[yashrajbharti]

Thanks for the resources, I will be correcting my way of writing the docs using this! and will fix the mistakes on this (and some other PRs soon)! I intend to write for clarity and completeness and this helps!

[yashrajbharti]

@wbamberg Thanks for referring me to the Page Templates. I believe most of the format is now correct. I do have a question: If the value of any property (e.g., valueInSpecifiedUnits) throws a DOMException, where is that generally documented?

[wbamberg]

@wbamberg Thanks for referring me to the Page Templates. I believe most of the format is now correct. I do have a question: If the value of any property (e.g., valueInSpecifiedUnits) throws a DOMException, where is that generally documented?

That's a good question! I think the answer in general is: we don't document exceptions like this. For example, in the case you gave, setting valueInSpecifiedUnits throws if the object is read only, but that's going to be true of any property, so it's not helpful to mention it.

[wbamberg]

Thanks for the updates. I've left comments on just one of the pages, as I expect similar comments are going to apply to the others.

Apart from things like formatting conventions, the tricky part is thinking about: what do we want to tell readers about these APIs? What do they need to know about them? Just paraphrasing the spec is usually not helpful, because then they might as well go and read the spec.

[wbamberg]

Thanks for the updates!

I started reviewing this but stopped when I got to https://github.com/mdn/content/pull/37013/files#diff-9122079f4f6ce53752a712afdd280a97e8be60040e0739ccb94c1f96bb2a492e, because it seems like it doesn't followed the template either.

Please, check that all the pages follow the template, and that any other comments that seem to be applicable to other pages (for example, the way the unit types are described and formatted) are followed. Otherwise I have to make the exact same comment again and again, and it isn't very efficient.

[wbamberg]

@wbamberg In the UnitType Page, I was unsure if we will document the unique constants that each of the SVGAngle.SVG_ANGLETYPE corresponds to. (For example SVGAngle.SVG_ANGLETYPE_DEG = 2)

I think actually since we have https://developer.mozilla.org/en-US/docs/Web/API/SVGAngle#constants, then we should not document the constant values in these pages at all, and just link to https://developer.mozilla.org/en-US/docs/Web/API/SVGAngle#constants. I'm not sure whether we should document the numeric values (but if we do, it should be in https://developer.mozilla.org/en-US/docs/Web/API/SVGAngle#constants).

[yashrajbharti]

@wbamberg Thanks for your answer, when I was documenting, I saw constants documented in the parent's interface in almost all cases. Such as SVGTransform | Constants, SVGTextContentElement | Constants, SVGFEColorMatrixElement | Constants the list goes on.

However it also seems these are following an older format as data is represented in tables.

With that said, only SVGAngle seems to miss out on constants being documented.

[yashrajbharti]

Made the fixes in value, and removed the part where we assumed angle as instance when we createSVGAngle as it will always be the case, so the word assume isn't required.

[github-actions]

This pull request has merge conflicts that must be resolved before it can be merged.

[wbamberg]

👍 looks great, thank you @yashrajbharti !