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

WebAPI: Update Method pages to modern structure (part 9) #15062

Merged
merged 4 commits into from
Apr 18, 2022

Conversation

OnkarRuikar
Copy link
Contributor

Continuing #14857

Summary

Updating the method pages to follow the current templates:
https://developer.mozilla.org/en-US/docs/MDN/Structures/Syntax_sections#constructors_and_methods
https://developer.mozilla.org/en-US/docs/MDN/Structures/Page_types/API_method_subpage_template

Changes Include:

  • fix syntax section
  • changing section titles to suggested titles in the template
  • change {{DOMxRef("DOMString")}} to string
  • remove extra spaces in between words and extra trailing spaces
  • other small corrections

Metadata

  • Fixes a typo, bug, or other error

@OnkarRuikar OnkarRuikar requested a review from a team as a code owner April 17, 2022 02:51
@OnkarRuikar OnkarRuikar requested review from sideshowbarker and removed request for a team April 17, 2022 02:51
@github-actions github-actions bot added the Content:WebAPI Web API docs label Apr 17, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Apr 17, 2022

Preview URLs

Flaws

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

URL: /en-US/docs/Web/API/CSSKeyframesRule/findRule
Title: CSSKeyframesRule.findRule()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSKeyframesRule/deleteRule
Title: CSSKeyframesRule.deleteRule()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSKeyframesRule/appendRule
Title: CSSKeyframesRule.appendRule()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSPrimitiveValue/getCounterValue
Title: CSSPrimitiveValue.getCounterValue()
on GitHub
Flaw count: 4

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)
    • /en-US/docs/Web/API/Counter does not exist
    • /en-US/docs/Web/API/Counter does not exist

URL: /en-US/docs/Web/API/CSSPrimitiveValue/getRGBColorValue
Title: CSSPrimitiveValue.getRGBColorValue()
on GitHub
Flaw count: 4

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)
    • /en-US/docs/Web/API/RGBColor does not exist
    • /en-US/docs/Web/API/RGBColor does not exist

URL: /en-US/docs/Web/API/CSSPrimitiveValue/setStringValue
Title: CSSPrimitiveValue.setStringValue()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSPrimitiveValue/getFloatValue
Title: CSSPrimitiveValue.getFloatValue()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSPrimitiveValue/getRectValue
Title: CSSPrimitiveValue.getRectValue()
on GitHub
Flaw count: 4

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)
    • /en-US/docs/Web/API/Rect does not exist
    • /en-US/docs/Web/API/Rect does not exist

URL: /en-US/docs/Web/API/CSSPrimitiveValue/getStringValue
Title: CSSPrimitiveValue.getStringValue()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSPrimitiveValue/setFloatValue
Title: CSSPrimitiveValue.setFloatValue()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSTransformComponent/toString
Title: CSSTransformComponent.toString()
on GitHub
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/transform-function/rotate3d()
    • Can't resolve /en-US/docs/Web/CSS/transform-function/rotate()

URL: /en-US/docs/Web/API/DataTransferItem/webkitGetAsEntry
Title: DataTransferItem.webkitGetAsEntry()
on GitHub
Flaw count: 4

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)
    • /en-US/docs/Web/API/Ul does not exist

URL: /en-US/docs/Web/API/CSS/escape
Title: CSS.escape()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSS/supports
Title: CSS.supports()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSValueList/item
Title: CSSValueList.item()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSGroupingRule/deleteRule
Title: CSSGroupingRule.deleteRule()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSGroupingRule/insertRule
Title: CSSGroupingRule.insertRule()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/Crypto/randomUUID
Title: Crypto.randomUUID()
on GitHub
Flaw count: 1

  • macros:
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/Crypto/getRandomValues
Title: Crypto.getRandomValues()
on GitHub
Flaw count: 1

  • macros:
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSTransformValue/entries
Title: CSSTransformValue.entries()
on GitHub
Flaw count: 1

  • macros:
    • /en-US/docs/Web/JavaScript/Reference/for...in does not exist

URL: /en-US/docs/Web/API/CountQueuingStrategy/size
Title: CountQueuingStrategy.size()
on GitHub
Flaw count: 1

  • macros:
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/DataTransfer/getData
Title: DataTransfer.getData()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CustomStateSet/entries
Title: CustomStateSet.entries()
on GitHub
Flaw count: 1

  • macros:
    • /en-US/docs/Web/JavaScript/Reference/Iterator does not exist

URL: /en-US/docs/Web/API/CSSRuleList/item
Title: CSSRuleList.item()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSStyleSheet/addRule
Title: CSSStyleSheet.addRule()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSStyleSheet/deleteRule
Title: CSSStyleSheet.deleteRule()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSStyleSheet/removeRule
Title: CSSStyleSheet.removeRule()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSStyleSheet/replaceSync
Title: CSSStyleSheet.replaceSync()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSStyleSheet/insertRule
Title: CSSStyleSheet.insertRule()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSStyleSheet/replace
Title: CSSStyleSheet.replace()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/createImageBitmap
Title: createImageBitmap()
on GitHub
Flaw count: 1

  • macros:
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSStyleDeclaration/item
Title: CSSStyleDeclaration.item()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSStyleDeclaration/getPropertyPriority
Title: CSSStyleDeclaration.getPropertyPriority()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSStyleDeclaration/getPropertyCSSValue
Title: CSSStyleDeclaration.getPropertyCSSValue()
on GitHub
Flaw count: 3

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)
  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS_Typed_OM_API

URL: /en-US/docs/Web/API/CSSStyleDeclaration/getPropertyValue
Title: CSSStyleDeclaration.getPropertyValue()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSStyleDeclaration/setProperty
Title: CSSStyleDeclaration.setProperty()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CSSStyleDeclaration/removeProperty
Title: CSSStyleDeclaration.removeProperty()
on GitHub
Flaw count: 2

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • wrong xref macro used (consider changing which macro you use)

URL: /en-US/docs/Web/API/CookieStore/set
Title: CookieStore.set()
on GitHub
Flaw count: 1

  • macros:
    • /en-US/docs/Glossary/serialize redirects to /en-US/docs/Glossary/Serialization

URL: /en-US/docs/Web/API/CSSNumericValue/type
Title: CSSNumericValue.type()
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/API/CredentialsContainer/create
Title: CredentialsContainer.create()
on GitHub
Flaw count: 5

  • macros:
    • /en-US/docs/Web/API/CredentialCreationOptions does not exist
    • /en-US/docs/Web/API/PasswordCredentialData does not exist
    • /en-US/docs/Web/API/CredentialData does not exist
    • /en-US/docs/Web/API/FederatedCredentialInit does not exist
    • /en-US/docs/Web/API/CredentialData does not exist

URL: /en-US/docs/Web/API/CredentialsContainer/get
Title: CredentialsContainer.get()
on GitHub
Flaw count: 1

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

External URLs

URL: /en-US/docs/Web/API/CSSKeyframesRule/findRule
Title: CSSKeyframesRule.findRule()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSKeyframesRule/deleteRule
Title: CSSKeyframesRule.deleteRule()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSKeyframesRule/appendRule
Title: CSSKeyframesRule.appendRule()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSPrimitiveValue/getCounterValue
Title: CSSPrimitiveValue.getCounterValue()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSPrimitiveValue/getRGBColorValue
Title: CSSPrimitiveValue.getRGBColorValue()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSPrimitiveValue/setStringValue
Title: CSSPrimitiveValue.setStringValue()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSPrimitiveValue/getFloatValue
Title: CSSPrimitiveValue.getFloatValue()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSPrimitiveValue/getRectValue
Title: CSSPrimitiveValue.getRectValue()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSPrimitiveValue/getStringValue
Title: CSSPrimitiveValue.getStringValue()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSPrimitiveValue/setFloatValue
Title: CSSPrimitiveValue.setFloatValue()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSTransformComponent/toMatrix
Title: CSSTransformComponent.toMatrix()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSTransformComponent/toString
Title: CSSTransformComponent.toString()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/DataTransferItem/getAsFile
Title: DataTransferItem.getAsFile()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/DataTransferItem/webkitGetAsEntry
Title: DataTransferItem.webkitGetAsEntry()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/DataTransferItem/getAsString
Title: DataTransferItem.getAsString()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSStyleValue/parseAll
Title: CSSStyleValue.parseAll()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSStyleValue/parse
Title: CSSStyleValue.parse()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CustomElementRegistry/upgrade
Title: CustomElementRegistry.upgrade()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CustomElementRegistry/get
Title: CustomElementRegistry.get()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CustomElementRegistry/whenDefined
Title: CustomElementRegistry.whenDefined()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CustomElementRegistry/define
Title: CustomElementRegistry.define()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSS/escape
Title: CSS.escape()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSS/supports
Title: CSS.supports()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSValueList/item
Title: CSSValueList.item()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSGroupingRule/deleteRule
Title: CSSGroupingRule.deleteRule()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSGroupingRule/insertRule
Title: CSSGroupingRule.insertRule()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Crypto/randomUUID
Title: Crypto.randomUUID()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/Crypto/getRandomValues
Title: Crypto.getRandomValues()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSTransformValue/values
Title: CSSTransformValue.values()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSTransformValue/keys
Title: CSSTransformValue.keys()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSTransformValue/toMatrix
Title: CSSTransformValue.toMatrix()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSTransformValue/entries
Title: CSSTransformValue.entries()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CountQueuingStrategy/size
Title: CountQueuingStrategy.size()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/DataTransfer/clearData
Title: DataTransfer.clearData()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/DataTransfer/mozGetDataAt
Title: DataTransfer.mozGetDataAt()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/DataTransfer/mozClearDataAt
Title: DataTransfer.mozClearDataAt()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/DataTransfer/getData
Title: DataTransfer.getData()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/DataTransfer/setDragImage
Title: DataTransfer.setDragImage()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/DataTransfer/mozSetDataAt
Title: DataTransfer.mozSetDataAt()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/DataTransfer/setData
Title: DataTransfer.setData()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/DataTransfer/mozTypesAt
Title: DataTransfer.mozTypesAt()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/DataTransfer/addElement
Title: DataTransfer.addElement()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CustomStateSet/values
Title: CustomStateSet.values()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CustomStateSet/keys
Title: CustomStateSet.keys()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CustomStateSet/clear
Title: CustomStateSet.clear()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CustomStateSet/has
Title: CustomStateSet.has()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CustomStateSet/add
Title: CustomStateSet.add()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CustomStateSet/delete
Title: CustomStateSet.delete()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CustomStateSet/forEach
Title: CustomStateSet.forEach()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CustomStateSet/entries
Title: CustomStateSet.entries()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/console/log
Title: console.log()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/console/table
Title: console.table()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/console/timeEnd
Title: console.timeEnd()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/console/timeLog
Title: console.timeLog()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/console/timeStamp
Title: console.timeStamp()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/console/trace
Title: console.trace()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/console/profileEnd
Title: console.profileEnd()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/console/profile
Title: console.profile()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/console/time
Title: console.time()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/console/warn
Title: console.warn()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSRuleList/item
Title: CSSRuleList.item()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSStyleSheet/addRule
Title: CSSStyleSheet.addRule()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSStyleSheet/deleteRule
Title: CSSStyleSheet.deleteRule()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSStyleSheet/removeRule
Title: CSSStyleSheet.removeRule()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSStyleSheet/replaceSync
Title: CSSStyleSheet.replaceSync()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSStyleSheet/insertRule
Title: CSSStyleSheet.insertRule()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSStyleSheet/replace
Title: CSSStyleSheet.replace()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSUnparsedValue/values
Title: CSSUnparsedValue.values()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSUnparsedValue/keys
Title: CSSUnparsedValue.keys()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSUnparsedValue/entries
Title: CSSUnparsedValue.entries()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/createImageBitmap
Title: createImageBitmap()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CookieStoreManager/unsubscribe
Title: CookieStoreManager.unsubscribe()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CookieStoreManager/subscribe
Title: CookieStoreManager.subscribe()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CookieStoreManager/getSubscriptions
Title: CookieStoreManager.getSubscriptions()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSStyleDeclaration/item
Title: CSSStyleDeclaration.item()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSStyleDeclaration/getPropertyPriority
Title: CSSStyleDeclaration.getPropertyPriority()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSStyleDeclaration/getPropertyCSSValue
Title: CSSStyleDeclaration.getPropertyCSSValue()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSStyleDeclaration/getPropertyValue
Title: CSSStyleDeclaration.getPropertyValue()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSStyleDeclaration/setProperty
Title: CSSStyleDeclaration.setProperty()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSStyleDeclaration/removeProperty
Title: CSSStyleDeclaration.removeProperty()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CookieStore/get
Title: CookieStore.get()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CookieStore/delete
Title: CookieStore.delete()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CookieStore/set
Title: CookieStore.set()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CookieStore/getAll
Title: CookieStore.getAll()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSNumericValue/sub
Title: CSSNumericValue.sub()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSNumericValue/equals
Title: CSSNumericValue.equals()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSNumericValue/add
Title: CSSNumericValue.add()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSNumericValue/type
Title: CSSNumericValue.type()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSNumericValue/div
Title: CSSNumericValue.div()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSNumericValue/min
Title: CSSNumericValue.min()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSNumericValue/to
Title: CSSNumericValue.to()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSNumericValue/max
Title: CSSNumericValue.max()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSNumericValue/toSum
Title: CSSNumericValue.toSum()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSNumericValue/parse
Title: CSSNumericValue.parse()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CSSNumericValue/mul
Title: CSSNumericValue.mul()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CredentialsContainer/create
Title: CredentialsContainer.create()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CredentialsContainer/get
Title: CredentialsContainer.get()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CredentialsContainer/store
Title: CredentialsContainer.store()
on GitHub

No new external URLs


URL: /en-US/docs/Web/API/CredentialsContainer/preventSilentAccess
Title: CredentialsContainer.preventSilentAccess()
on GitHub

No new external URLs

(this comment was updated 2022-04-18 06:08:05.908681)

Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

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

Awesome work @OnkarRuikar . I had one question about some weirdness in the DataTransfer API.

files/en-us/web/api/datatransfer/setdragimage/index.md Outdated Show resolved Hide resolved
@OnkarRuikar
Copy link
Contributor Author

OnkarRuikar commented Apr 17, 2022

@wbamberg As per the syntax section the parameter names do not have any decoration so _imgElement_ and `imgElement` are both invalid. A CSS rule takes care of making param names bold. So, I think there is no need for us to do it in markdown.

.main-page-content dl dt {
  margin-top: 2rem;
  margin-bottom: .5rem;
  font-weight: var(--font-body-strong-weight);
}

Good catch on Arguments. It'll be handled in upcoming PRs.

I can include removing decorations from parameter names in the PR series. But if we add too many things, the reviews and overall process will become slow. And there are 1458 method pages. 😯 If we focus on one type of correction in a PR series then hundreds of files can be pulled in a PR. I don't know how is the workload on your side. I leave the decision of dealing everything in a single pass or separate things over multiple passes.

Honestly, for every API authors have used their own imagination writing syntax sections. I have discussed the bottleneck on my side with Jean here: #15042 (comment)

@sideshowbarker sideshowbarker removed their request for review April 17, 2022 08:02
files/en-us/web/api/console/trace/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/cookiestore/set/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/credentialscontainer/store/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/datatransfer/mozcleardataat/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/datatransfer/mozgetdataat/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/datatransfer/mozsetdataat/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/datatransfer/moztypesat/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/datatransfer/getdata/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/datatransfer/addelement/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/datatransfer/setdata/index.md Outdated Show resolved Hide resolved
OnkarRuikar and others added 2 commits April 18, 2022 11:33
Co-authored-by: Jean-Yves Perrier <[email protected]>
Co-authored-by: Jean-Yves Perrier <[email protected]>
Copy link
Contributor

@teoli2003 teoli2003 left a comment

Choose a reason for hiding this comment

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

Thanks!

@teoli2003 teoli2003 merged commit 1b37063 into mdn:main Apr 18, 2022
@OnkarRuikar OnkarRuikar deleted the onk-method2 branch April 18, 2022 06:20
@wbamberg
Copy link
Collaborator

@wbamberg As per the syntax section the parameter names do not have any decoration so _imgElement_ and `imgElement` are both invalid. A CSS rule takes care of making param names bold. So, I think there is no need for us to do it in markdown.

This seems to be another discrepancy with the JS docs, where code format for parameter names seems to be the most common approach (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters etc etc).

I can include removing decorations from parameter names in the PR series. But if we add too many things, the reviews and overall process will become slow. And there are ~2300 method pages. 😯 If we focus on one type of correction in a PR series then hundreds of files can be pulled in a PR. I don't know how is the workload on your side. I leave the decision of dealing everything in a single pass or separate things over multiple passes.

I'm happy with an answer like "this isn't in scope for this PR". There are so many things to fix, we can't try to do them all at once, and what you have here is already a big improvement.

@OnkarRuikar
Copy link
Contributor Author

I'm happy with an answer like "this isn't in scope for this PR". There are so many things to fix, we can't try to do them all at once

Let's handle fixing ### Parameters section in next PR series.

@wbamberg, @teoli2003 If you have such mass corrections in mind do let me know. For example, updating page tags, as per BCD, with 'deprecated', 'experimental', 'non-standard'. Currently, BCD and page tags are not in sync. I don't know how they are updated.

@wbamberg
Copy link
Collaborator

wbamberg commented Apr 19, 2022

I'm happy with an answer like "this isn't in scope for this PR". There are so many things to fix, we can't try to do them all at once

Let's handle fixing ### Parameters section in next PR series.

For example, updating page tags, as per BCD, with 'deprecated', 'experimental', 'non-standard'. Currently, BCD and page tags are not in sync. I don't know how they are updated.

What I would much prefer to do here is to deprecate and eventually remove these tags in favour of the BCD values, and have the platform generate banners for these pages from that data: openwebdocs/project#81.

@wbamberg
Copy link
Collaborator

wbamberg commented Apr 19, 2022

If you have such mass corrections in mind do let me know.

I'm currently supposed to be working on a project to define "page type" front matter (openwebdocs/project#91) and once we have these types defined there will be work to add them to add the pages they apply to (and also to remove tags that are currently used to do a similar job).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants