mirror of
https://github.com/HabitRPG/habitica.git
synced 2025-12-16 22:27:26 +01:00
improvements to apidocs comments (#11832)
* make corrections and improvements to apidocs (no code changes) * make further minor tweaks to apidocs that were previously changed * make one extra small change for consistency * 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) * apply eslint-disable max-len around block comments that need to have a long line The `@api ` lines can't have a line break in them because it would cause the first part of the text to not be displayed on the apidocs website. Using `// eslint-disable-line max-len` at the end of an `@api ` line doesn't work, possibly because it's nesting a comment inside a multi-line comment. The only way I've found to ignore the `max-len` rule is to put disable and enable comments around the whole comment block.
This commit is contained in:
@@ -75,8 +75,10 @@ api.getNews = {
|
||||
};
|
||||
|
||||
/**
|
||||
* @api {post} /api/v3/news/tell-me-later Get latest Bailey announcement in a second moment
|
||||
* @api {post} /api/v3/news/tell-me-later Allow latest Bailey announcement to be read later
|
||||
* @apiName TellMeLaterNews
|
||||
* @apiDescription Add a notification to allow viewing of the latest "New Stuff by Bailey" message.
|
||||
* Prevent this specific Bailey message from appearing automatically.
|
||||
* @apiGroup News
|
||||
*
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user