Skip to content

WebXR docs: Rm syntax from properties; normalize Value section #8565

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.

Sign up for GitHub

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

Jump to bottom
Merged
wbamberg merged 1 commit into from
Sep 2, 2021
Merged

WebXR docs: Rm syntax from properties; normalize Value section #8565

wbamberg merged 1 commit into from
Sep 2, 2021

Conversation

@Elchi3
Copy link
Member

@Elchi3 Elchi3 commented Sep 2, 2021

This is me trying to make the WebXR doc set to be a role-model per our latest API docs guidelines.

  • Remove syntax sections from property pages
  • Normalize Value section to be an h2

@Elchi3 Elchi3 requested a review from a team as a code owner September 2, 2021 15:14
@Elchi3 Elchi3 requested review from wbamberg and removed request for a team September 2, 2021 15:14
@github-actions
Copy link
Contributor

github-actions bot commented Sep 2, 2021

Preview URLs

Flaws

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

URL: /en-US/docs/Web/API/XRReferenceSpaceEvent/transform
Title: XRReferenceSpaceEvent.transform
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/API/XRWebGLLayer/ignoreDepthValues
Title: XRWebGLLayer.ignoreDepthValues
on GitHub
Flaw count: 2

  • macros:
    • /en-US/docs/Web/API/WebGLLayerInit does not exist
  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/API/XRWebGLLayer/framebuffer
Title: XRWebGLLayer.framebuffer
on GitHub
Flaw count: 7

  • macros:
    • /en-US/docs/Web/API/WebXRLayerInit/depth does not exist
    • /en-US/docs/Web/API/WebXRLayerInit/stencil does not exist
    • /en-US/docs/Web/API/WebGLLayerInit/alpha does not exist
    • /en-US/docs/Web/API/WebGLContextAttributes/premultipliedAlpha does not exist
    • /en-US/docs/Web/API/WebGLLayerInit does not exist
    • and 1 more flaws omitted
  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/API/XRWebGLLayer/framebufferHeight
Title: XRWebGLLayer.framebufferHeight
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/API/XRWebGLLayer/framebufferWidth
Title: XRWebGLLayer.framebufferWidth
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/API/XRPose/linearVelocity
Title: XRPose.linearVelocity
on GitHub
Flaw count: 1

  • bad_bcd_queries:
    • No BCD data for query: api.XRPose.linearVelocity

URL: /en-US/docs/Web/API/XRPose/angularVelocity
Title: XRPose.angularVelocity
on GitHub
Flaw count: 1

  • bad_bcd_queries:
    • No BCD data for query: api.XRPose.angularVelocity

External URLs

URL: /en-US/docs/Web/API/XRBoundedReferenceSpace/boundsGeometry
Title: XRBoundedReferenceSpace.boundsGeometry
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRReferenceSpaceEvent/referenceSpace
Title: XRReferenceSpaceEvent.referenceSpace
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRReferenceSpaceEvent/transform
Title: XRReferenceSpaceEvent.transform
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRWebGLLayer/ignoreDepthValues
Title: XRWebGLLayer.ignoreDepthValues
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRWebGLLayer/framebuffer
Title: XRWebGLLayer.framebuffer
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRWebGLLayer/framebufferHeight
Title: XRWebGLLayer.framebufferHeight
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRWebGLLayer/framebufferWidth
Title: XRWebGLLayer.framebufferWidth
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRPermissionStatus/granted
Title: XRPermissionStatus.granted
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRRenderState/baseLayer
Title: XRRenderState.baseLayer
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRRenderState/inlineVerticalFieldOfView
Title: XRRenderState.inlineVerticalFieldOfView
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRRenderState/depthFar
Title: XRRenderState.depthFar
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRRenderState/depthNear
Title: XRRenderState.depthNear
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRInputSource/targetRaySpace
Title: XRInputSource.targetRaySpace
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRInputSource/profiles
Title: XRInputSource.profiles
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRInputSource/gripSpace
Title: XRInputSource.gripSpace
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRInputSource/targetRayMode
Title: XRInputSource.targetRayMode
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRInputSource/handedness
Title: XRInputSource.handedness
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRDepthInformation/width
Title: XRDepthInformation.width
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRDepthInformation/rawValueToMeters
Title: XRDepthInformation.rawValueToMeters
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRDepthInformation/normDepthBufferFromNormView
Title: XRDepthInformation.normDepthBufferFromNormView
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRDepthInformation/height
Title: XRDepthInformation.height
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRCPUDepthInformation/data
Title: XRCPUDepthInformation.data
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRInputSourcesChangeEvent/removed
Title: XRInputSourcesChangeEvent.removed
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRInputSourcesChangeEvent/added
Title: XRInputSourcesChangeEvent.added
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRInputSourcesChangeEvent/session
Title: XRInputSourcesChangeEvent.session
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRInputSourceArray/length
Title: XRInputSourceArray.length
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRWebGLDepthInformation/texture
Title: XRWebGLDepthInformation.texture
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRViewport/width
Title: XRViewport.width
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRViewport/x
Title: XRViewport.x
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRViewport/y
Title: XRViewport.y
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRViewport/height
Title: XRViewport.height
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRRigidTransform/position
Title: XRRigidTransform.position
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRRigidTransform/matrix
Title: XRRigidTransform.matrix
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRRigidTransform/inverse
Title: XRRigidTransform.inverse
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRRigidTransform/orientation
Title: XRRigidTransform.orientation
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/Navigator/xr
Title: Navigator.xr
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRLightEstimate/primaryLightIntensity
Title: XRLightEstimate.primaryLightIntensity
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRLightEstimate/sphericalHarmonicsCoefficients
Title: XRLightEstimate.sphericalHarmonicsCoefficients
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRLightEstimate/primaryLightDirection
Title: XRLightEstimate.primaryLightDirection
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRSession/preferredReflectionFormat
Title: XRSession.preferredReflectionFormat
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRSession/environmentBlendMode
Title: XRSession.environmentBlendMode
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRSession/interactionMode
Title: XRSession.interactionMode
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRSession/inputSources
Title: XRSession.inputSources
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRSession/renderState
Title: XRSession.renderState
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRSession/domOverlayState
Title: XRSession.domOverlayState
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRSession/visibilityState
Title: XRSession.visibilityState
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRSession/depthDataFormat
Title: XRSession.depthDataFormat
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRSession/depthUsage
Title: XRSession.depthUsage
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRLightProbe/probeSpace
Title: XRLightProbe.probeSpace
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRLightProbe/onreflectionchange
Title: XRLightProbe.onreflectionchange
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRFrame/trackedAnchors
Title: XRFrame.trackedAnchors
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRFrame/session
Title: XRFrame.session
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRPose/transform
Title: XRPose.transform
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRPose/emulatedPosition
Title: XRPose.emulatedPosition
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRPose/linearVelocity
Title: XRPose.linearVelocity
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRPose/angularVelocity
Title: XRPose.angularVelocity
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRInputSourceEvent/inputSource
Title: XRInputSourceEvent.inputSource
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRInputSourceEvent/frame
Title: XRInputSourceEvent.frame
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRSessionEvent/session
Title: XRSessionEvent.session
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRView/transform
Title: XRView.transform
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRView/eye
Title: XRView.eye
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRView/projectionMatrix
Title: XRView.projectionMatrix
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRViewerPose/views
Title: XRViewerPose.views
on GitHub

No new external URLs

URL: /en-US/docs/Web/API/XRAnchor/anchorSpace
Title: XRAnchor.anchorSpace
on GitHub

No new external URLs

wbamberg
wbamberg approved these changes Sep 2, 2021
View reviewed changes
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.

👍

@wbamberg wbamberg merged commit a27eb50 into mdn:main Sep 2, 2021
@Elchi3 Elchi3 deleted the webxr-properties-syntax branch September 3, 2021 06:49
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 3, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@wbamberg wbamberg wbamberg approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Elchi3 @wbamberg