HaxeFoundation/haxe

[doc] Type API only guaranteed to work with Haxe generated types.

Open

#6,113 opened on Mar 20, 2017

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Haxe (704 forks)auto 404
Hacktoberfestdocumentation

Repository metrics

Stars
 (6,901 stars)
PR merge metrics
 (PR metrics pending)

Description

As mentioned in #5645 there should be a notice in Type API docs.

Contributor guide

Research direction
Add a notice in the Type API documentation indicating that the Type API is only guaranteed to work with Haxe generated types.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90