bitovi / bitovi/canjs.com

Hidden APIs should be documented

Open
#155 4 comments 0 reactions 1 assignee Claimed by @andykant View on GitHub
Dominant language
JavaScript
Stars
17
Forks
12
PR merge metrics
No merged PRs in 30d

Description

This is most necessary for features where something happens automatically behind the scenes by default, but has a hidden API for disabling (where there might be a reason to disable it).

The best example is **can.Model** which automatically converts the responses of findOne/findAll to model instances. In a recent version of can (1.1.5 or so), create/update also started converting by default. You can only override these behaviors by using a non-obvious hidden API: Setting makeFindAll/makeFindOne/makeCreate/makeUpdate as null. While the existing design for this functionality could probably use some refactoring, in the meantime we should document the hidden APIs.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.