Microsoft/TypeScript

Document WebGLContextAttributes

Open

#42,290 opened on Jan 12, 2021

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

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

Tech stack
typescript
Domain
documentation
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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic TypeScriptUnderstanding of WebGL
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Add JSDoc comments to `interface WebGLContextAttributes` in `lib.dom.d.ts` around line 1960. Refer to the WebGL Context Creation Spec (https://www.khronos.org/registry/webgl/specs/latest/1.0/#5.2.1) for the definitions. Ensure the comments follow the existing documentation style in the file.
Document WebGLContextAttributes · Microsoft/TypeScript#42290 | Good First Issue