Skip to content
This repository has been archived by the owner on Jul 15, 2022. It is now read-only.

Add doc annotations #51

Merged
merged 9 commits into from
Feb 26, 2019
Merged

Add doc annotations #51

merged 9 commits into from
Feb 26, 2019

Conversation

tafsiri
Copy link
Contributor

@tafsiri tafsiri commented Feb 22, 2019

This adds doc annotations to tfjs vis in preparation for hosting its docs on the website.


This change is Reviewable

Copy link

@nsthorat nsthorat left a comment

Choose a reason for hiding this comment

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

Reviewed 14 of 14 files at r1.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @tafsiri)


src/visor.ts, line 90 at r1 (raw file):

 */
/**
 * @doc {heading: 'Visor & Surfaces', subheading: 'Visor Methods'}

I think this fits on line line, no need for the multiline jsdoc if you want, also elsewhere


src/show/model.ts, line 97 at r1 (raw file):

/**
 * @doc {heading: 'Models & Tensors', subheading: 'Model Inspection', namespace:
 * 'show'}

the way I've been doing multiline docs is like:

@doc {
  heading: ...,
  subheading: ...
}

Copy link
Contributor Author

@tafsiri tafsiri left a comment

Choose a reason for hiding this comment

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

Reviewable status: 12 of 14 files reviewed, all discussions resolved (waiting on @nsthorat)


src/visor.ts, line 90 at r1 (raw file):

Previously, nsthorat (Nikhil Thorat) wrote…

I think this fits on line line, no need for the multiline jsdoc if you want, also elsewhere

Done here and elsewhere


src/show/model.ts, line 97 at r1 (raw file):

Previously, nsthorat (Nikhil Thorat) wrote…

the way I've been doing multiline docs is like:

@doc {
  heading: ...,
  subheading: ...
}

Done here and elsewhere

@tafsiri tafsiri merged commit 1fd6150 into master Feb 26, 2019
@tafsiri tafsiri deleted the add-doc-annotations branch April 30, 2019 15:53
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
2 participants