Skip to content
This repository has been archived by the owner on Aug 24, 2021. It is now read-only.

Awesome API Documentation #9

Merged
merged 4 commits into from
Dec 14, 2016
Merged

Awesome API Documentation #9

merged 4 commits into from
Dec 14, 2016

Conversation

dignifiedquire
Copy link
Member

@dignifiedquire dignifiedquire commented Dec 7, 2016

@dignifiedquire dignifiedquire changed the title [WIP] Awesome API Documentation Awesome API Documentation Dec 12, 2016

/**
* @param {string|number} nameOrCode
* @returns {Base}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where is Base defined?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In base.js, but currently not documented as it is private

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, so people get the idea that a Base is returned, but they have no idea of what a base is. We should document at least what the base includes here, to not confuse people.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed for now

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants