Difference between revisions of "Exorcise.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Add NOTOC to Spinach function page header)
m (Rename Arguments section heading to Parameters)
Line 6: Line 6:
 
     exorcise(mode)
 
     exorcise(mode)
  
−
==Arguments==
+
==Parameters==
  
 
   mode  - 'online' (default) checks the documentation
 
   mode  - 'online' (default) checks the documentation

Revision as of 18:48, 5 June 2026

Searches Spinach distribution folders for any functions that do not conform to the house style. Opens the first one and complains to the console.

Syntax

    exorcise(mode)

Parameters

  mode   - 'online' (default) checks the documentation
           Wiki for the corrsponding page; 'offline'
           skips the Wiki check 

Outputs

This function opens the first non-compliant file it finds and prints a message to the console.

Notes

Any user contribution that this function has something to say about will either be brought under the house style, or rejected back to the user, depending on the amount of work involved. Always run this function before a commit if you have write access to Spinach repository.

See also

smack.m

Version 2.2, authors: Ilya Kuprov