Skip to content

Fixing array return formatting in docs #629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
johnhaley81 merged 1 commit into from
Jul 20, 2015
Merged

Fixing array return formatting in docs #629

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion lib/convenient_hunk.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ ConvenientHunk.prototype.size = function() {

/**
* The lines in this hunk
* @return Promise({[ConvenientLine]}) a promise that resolves to an array of
* @async
* @return {Array<ConvenientLine>} a promise that resolves to an array of
* ConvenientLines
*/
ConvenientHunk.prototype.lines = function() {
Expand Down
3 changes: 2 additions & 1 deletion lib/convenient_patch.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ ConvenientPatch.prototype.size = function() {

/**
* The hunks in this patch
* @return Promise({[ConvenientHunk]}) a promise that resolves to an array of
* @async
* @return {Array<ConvenientHunk>} a promise that resolves to an array of
* ConvenientHunks
*/
ConvenientPatch.prototype.hunks = function() {
Expand Down
3 changes: 2 additions & 1 deletion lib/diff.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ var Patch = NodeGit.Patch;
/**
* Retrieve patches in this difflist
*
* @return Promise({[ConvenientPatch]}) a promise that resolves to an array of
* @async
* @return {Array<ConvenientPatch>} a promise that resolves to an array of
* ConvenientPatches
*/
Diff.prototype.patches = function() {
Expand Down
2 changes: 1 addition & 1 deletion lib/tree.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Tree.prototype.getEntry = function(filePath, callback) {

/**
* Return an array of the entries in this tree (excluding its children).
* @return {[TreeEntry]} an array of TreeEntrys
* @return {Array<TreeEntry>} an array of TreeEntrys
*/
Tree.prototype.entries = function() {
var size = this.entryCount();
Expand Down