Skip to content
This repository has been archived by the owner on Apr 17, 2023. It is now read-only.

RAINCATCH-1186 API docs review #128

Merged
merged 2 commits into from
Sep 22, 2017

Conversation

austincunningham
Copy link
Member

@austincunningham austincunningham commented Sep 20, 2017

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

  • Documentation

Additional Notes

@coveralls
Copy link

Coverage Status

Changes Unknown when pulling bff4e4f on austincunningham:RAINCATCH-1186 into ** on feedhenry-raincatcher:master**.

1 similar comment
@coveralls
Copy link

Coverage Status

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
Copy link
Member

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,
Copy link
Member

Choose a reason for hiding this comment

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

, => .

@wtrocki
Copy link
Member

wtrocki commented Sep 20, 2017

Looks really good.
@austincunningham Out of curiosity -
Did you checked if there are some missing comments?

@wtrocki
Copy link
Member

wtrocki commented Sep 20, 2017

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.

@coveralls
Copy link

Coverage Status

Changes Unknown when pulling 9a9a617 on austincunningham:RAINCATCH-1186 into ** on feedhenry-raincatcher:master**.

1 similar comment
@coveralls
Copy link

Coverage Status

Changes Unknown when pulling 9a9a617 on austincunningham:RAINCATCH-1186 into ** on feedhenry-raincatcher:master**.

Copy link
Member Author

@austincunningham austincunningham left a 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.

@wtrocki wtrocki merged commit 53b4ef2 into feedhenry-raincatcher:master Sep 22, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Development

Successfully merging this pull request may close these issues.

None yet

4 participants