mirror of
https://github.com/sudoxnym/habitica.git
synced 2026-07-14 16:02:14 +00:00
fix lines that are too long
Each line was fixed by one of these: - changing the wording - breaking into separate lines - adding eslint-disable-line max-len (necessary for `@api ` lines because a line break there causes the first part of the text to not be displayed on the apidocs website)
This commit is contained in:
parent
1b39338eec
commit
ac52da5be2
6 changed files with 15 additions and 10 deletions
|
|
@ -154,7 +154,7 @@ const heroAdminFields = 'contributor balance profile.name purchased items auth f
|
|||
* @apiGroup Hall
|
||||
* @apiPermission Admin
|
||||
*
|
||||
* @apiDescription Returns the profile of the given user. The user does not need to be a contributor.
|
||||
* @apiDescription Returns the profile of the given user. User does not need to be a contributor.
|
||||
*
|
||||
* @apiSuccess {Object} data The user object
|
||||
*
|
||||
|
|
|
|||
|
|
@ -1479,7 +1479,8 @@ api.unlinkOneTask = {
|
|||
/**
|
||||
* @api {post} /api/v3/tasks/clearCompletedTodos Delete user's completed todos
|
||||
* @apiName ClearCompletedTodos
|
||||
* @apiDescription Deletes all of a user's completed To-Dos except those belonging to active Challenges and Group Plans
|
||||
* @apiDescription Deletes all of a user's completed To-Dos except
|
||||
* those belonging to active Challenges and Group Plans.
|
||||
* @apiGroup Task
|
||||
*
|
||||
* @apiExample {curl} Example call:
|
||||
|
|
|
|||
|
|
@ -112,7 +112,7 @@ api.getGroupTasks = {
|
|||
};
|
||||
|
||||
/**
|
||||
* @api {post} /api/v3/group/:groupId/tasks/:taskId/move/to/:position Move a group task to a specified position
|
||||
* @api {post} /api/v3/group/:groupId/tasks/:taskId/move/to/:position Move group task to new position
|
||||
* @apiDescription Moves a group task to a specified position
|
||||
* @apiVersion 3.0.0
|
||||
* @apiName GroupMoveTask
|
||||
|
|
|
|||
|
|
@ -91,7 +91,7 @@ api.getUser = {
|
|||
};
|
||||
|
||||
/**
|
||||
* @api {get} /api/v3/user/inventory/buy Get the gear items available for purchase for the authenticated user
|
||||
* @api {get} /api/v3/user/inventory/buy Get equipment/gear items available for user to purchase
|
||||
* @apiName UserGetBuyList
|
||||
* @apiGroup User
|
||||
*
|
||||
|
|
@ -244,10 +244,12 @@ api.updateUser = {
|
|||
*
|
||||
* @apiError {BadRequest} MissingPassword Missing password.
|
||||
* @apiError {BadRequest} NotAuthorized Wrong password.
|
||||
* @apiError {BadRequest} NotAuthorized Please type DELETE in all capital letters to delete your account.
|
||||
* @apiError {BadRequest} NotAuthorized Please type DELETE in all capital letters to
|
||||
* delete your account.
|
||||
* @apiError {BadRequest} BadRequest Account deletion feedback is limited to 10,000 characters.
|
||||
* For lengthy feedback, email ${TECH_ASSISTANCE_EMAIL}.
|
||||
* @apiError {BadRequest} NotAuthorized You have an active subscription, cancel your plan before deleting your account.
|
||||
* @apiError {BadRequest} NotAuthorized You have an active subscription,
|
||||
* cancel your plan before deleting your account.
|
||||
*
|
||||
* @apiErrorExample {json}
|
||||
* {
|
||||
|
|
@ -707,7 +709,7 @@ api.buyQuest = {
|
|||
};
|
||||
|
||||
/**
|
||||
* @api {post} /api/v3/user/buy-special-spell/:key Buy special item (card, avatar transformation, etc)
|
||||
* @api {post} /api/v3/user/buy-special-spell/:key Buy special item (card, avatar transformation)
|
||||
* @apiDescription Includes gift cards (e.g., birthday card), and avatar Transformation
|
||||
* Items and their antidotes (e.g., Snowball item and Salt reward).
|
||||
* @apiName UserBuySpecialSpell
|
||||
|
|
@ -1670,7 +1672,7 @@ api.togglePinnedItem = {
|
|||
};
|
||||
|
||||
/**
|
||||
* @api {post} /api/v3/user/move-pinned-item/:type/:path/move/to/:position Move a pinned item in the rewards column to a new position after being sorted
|
||||
* @api {post} /api/v3/user/move-pinned-item/:type/:path/move/to/:position Move a pinned item in the rewards column to a new position after being sorted // eslint-disable-line max-len
|
||||
* @apiName MovePinnedItem
|
||||
* @apiGroup User
|
||||
*
|
||||
|
|
|
|||
|
|
@ -5,9 +5,10 @@ import { authWithHeaders } from '../../../middlewares/auth';
|
|||
const api = {};
|
||||
|
||||
/**
|
||||
* @api {post} /api/v3/user/allocate Allocate a single Stat Point (previously called Attribute Point)
|
||||
* @api {post} /api/v3/user/allocate Allocate a single Stat Point
|
||||
* @apiName UserAllocate
|
||||
* @apiGroup User
|
||||
* @apiDescription Allocates a single Stat Point (previously called Attribute Point).
|
||||
*
|
||||
* @apiParam (Query) {String="str","con","int","per"} stat The Stat to increase. Default is 'str'
|
||||
*
|
||||
|
|
|
|||
|
|
@ -15,7 +15,8 @@ const api = {};
|
|||
* that will unsubscribe the user from emails.
|
||||
* Does not require authentication.
|
||||
*
|
||||
* @apiParam (Query) {String} code An unsubscription code that contains an encrypted User ID or email address
|
||||
* @apiParam (Query) {String} code An unsubscription code that contains an encrypted User ID or
|
||||
* email address
|
||||
*
|
||||
* @apiSuccess {String} Webpage An html success message
|
||||
*
|
||||
|
|
|
|||
Loading…
Reference in a new issue