Microsoft/TypeScript

Document WebGLContextAttributes

Open

#42,290 opened on Jan 12, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (6,726 forks)batch import
BugDomain: lib.d.tsHelp Wanted

Repository metrics

Stars
 (48,455 stars)
PR merge metrics
 (Avg merge 6d 17h) (9 merged PRs in 30d)

Description

lib Update Request

Configuration Check

My compilation target is ES2015 and my lib is the default.

Missing / Incorrect Definition

Missing documentation in interface WebGLContextAttributes lib.dom.d.ts, line 1960

Sample Code

The missing documentation results in gaps in auto-generated documentation for rendering libraries, i.e Babylon.js - EngineOptions.

Documentation Link

WebGLContextAttributes definitions can be found at WebGL Context Creation Spec.

Contributor guide

Research direction
Locate the WebGLContextAttributes interface in lib.dom.d.ts at line ~1960, then add JSDoc comments using the WebGL spec link provided (https://www.khronos.org/registry/webgl/specs/latest/1.0/#5.2.1). Ensure the documentation describes each attribute (alpha, depth, stencil, antialias, premultipliedAlpha, preserveDrawingBuffer, failIfMajorPerformanceCaveat, powerPreference). Submit a PR to the Microsoft/TypeScript repository.
Tech stack
typescript
Domain
frontenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85