Merge pull request #4255 from quacksouls/doc-gang-canRecruitMember

DOC: `gang.canRecruitMember()`: typo fix and elaboration
This commit is contained in:
hydroflame 2022-10-19 11:44:03 -04:00 committed by GitHub
commit b25b4b5e27
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -3376,7 +3376,15 @@ export interface Gang {
* @remarks
* RAM cost: 1 GB
*
* Returns boolean indicating whether a member can currently be recruited
* Returns a boolean indicating whether a member can currently be recruited.
*
* Once you have successfully created a gang by using the function
* {@link Gang.createGang | createGang}, you can immediately recruit a small
* number of members to your gang. After you have recruited the founding
* members, to recruit another member you must increase your respect. The
* more members you want to recruit, the more respect you require. If your
* gang has the maximum number of members, then this function would return
* false.
*
* @returns True if a member can currently be recruited, false otherwise.
*/