Skip to content
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.

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

getTotalInvites -> getTotalUsableInvites #34

Merged
merged 1 commit into from
Jun 4, 2019
Merged

Conversation

Fang-
Copy link
Member

@Fang- Fang- commented Jun 3, 2019

@jtobin as mentioned, this is more useful if it checks for invites that you can actually use, rather than invites you have but can't actually get a planet for.

@Fang- Fang- requested a review from jtobin June 3, 2019 15:58
* @param {Number} point - The point whose invites to count
* @return {Promise<Number>} Total amount of invites
*/
module.exports.getTotalInvites = async function(contracts, point) {
const pool = await internal.getPool(contracts, as);
Copy link
Contributor

Choose a reason for hiding this comment

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

What the.. did this spurious-looking as pass my previous review? 🤔

@@ -77,7 +87,7 @@ module.exports.getTotalInvites = async function(contracts, point) {
* Generate a list of planets for as to send as invites
* NOTE that the returned list isn't guaranteed to contain exactly amount items,
Copy link
Contributor

Choose a reason for hiding this comment

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

I forgot to mention this before as well, but technically this NOTE in the docstring should probably be better-formatted, since these things are designed to render nicely via JSDoc.

Which reminds me.. I should immediately tweak package.json to rebuild the docs before every publish. The API docs link in the README is an embarrassment.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah, of course. Might just need to be Note: or w/e instead then? Thanks!

Copy link
Contributor

@jtobin jtobin left a comment

Choose a reason for hiding this comment

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

LGTM. I'll also make an issue to remind myself to actually rebuild the docs.

@jtobin jtobin merged commit a138ab9 into master Jun 4, 2019
@jtobin jtobin deleted the delegated-sending branch June 4, 2019 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants