-
Notifications
You must be signed in to change notification settings - Fork 14
RAINCATCH-1186 API docs review #128
RAINCATCH-1186 API docs review #128
Conversation
Changes Unknown when pulling bff4e4f on austincunningham:RAINCATCH-1186 into ** on feedhenry-raincatcher:master**. |
1 similar comment
Changes Unknown when pulling bff4e4f on austincunningham:RAINCATCH-1186 into ** on feedhenry-raincatcher:master**. |
* Sor more information on the sync client API, | ||
* See https://tinyurl.com/yc5q3rj3 | ||
* For more information on the sync client API, | ||
* See https://github.com/feedhenry/fh-sync/blob/master/docs/sync_service.adoc |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreement was to point to portal for the moment as documentation is outdated.
@@ -6,8 +6,8 @@ import * as _ from 'lodash'; | |||
/** | |||
* Wrapper class around sync to allow easier operations on a single data set. | |||
* | |||
* Sor more information on the sync client API, | |||
* See https://tinyurl.com/yc5q3rj3 | |||
* For more information on the sync client API, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
, => .
Looks really good. |
Took a quick glance into render myself. It looks good. I found some issues around interfaces - we no longer using them. Going to create follow up issues. |
Changes Unknown when pulling 9a9a617 on austincunningham:RAINCATCH-1186 into ** on feedhenry-raincatcher:master**. |
1 similar comment
Changes Unknown when pulling 9a9a617 on austincunningham:RAINCATCH-1186 into ** on feedhenry-raincatcher:master**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing comments around tests mainly. Didn't think they were needed.
Motivation
Review API documentation generated by typedoc
Description
fix any issues with in raincatcher-core so they will render in the api typedoc docs. Mainly fix relative links.
Progress
Additional Notes