microsoft / microsoft/TypeScript

Document WebGLContextAttributes

Open
#42,290 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Bug Domain: lib.d.ts Help Wanted
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in lib/lib.dom.d.ts around line 1960 at interface WebGLContextAttributes, then compare its definitions with the WebGL Context Creation Spec section 5.2.1. Done means the interface has documentation for the currently undocumented definitions so auto-generated documentation, such as Babylon.js EngineOptions, no longer has those gaps.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.