Skip to content

Commit 9793cb6

Browse files
committed
MOSOrderPositionFinder: improve docblocks
1 parent 9768ce3 commit 9793cb6

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

SpeciesHelper/modules/MOSOrderPositionFinder.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Utilities that help user scripts that manipulate wikicode properly follow English Wikipedia's MOS:ORDER.
2+
* Utilities to help user scripts properly follow English Wikipedia's MOS:ORDER. Most of the methods need wikitext and a specific MOS:ORDER section as parameters, then output something useful related to MOS:ORDER.
33
*/
44
export class MOSOrderPositionFinder {
55

@@ -39,7 +39,7 @@ export class MOSOrderPositionFinder {
3939
* @param {string} wikicode
4040
* @param {string} needle The string to insert
4141
* @param {string} section One of: top, shortDescription, displayTitle, hatnotes, featured, deletionAndProtection, maintenanceTags, engvar, infoboxes, languageScriptNeeded, sidebars, lead, tableOfContents, body, worksOrPublications, seeAlso, notesAndReferences, furtherReading, externalLinks, successionAndGeographyBoxes, navboxes, portalBar, taxonBar, authorityControl, geographicalCoordinates, defaultSort, categories, improveCategories, stubTemplates, bottom
42-
* @return {number} sectionPosition: -1 if no section, integer if section. Counting starts at 0.
42+
* @return {string} wikitext Transformed wikitext, containing the inserted string
4343
*/
4444
insertAtSection( wikicode, needle, section ) {
4545
this.wikitext = wikicode;

0 commit comments

Comments
 (0)