Difference between revisions of "Exorcise.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Normalise sequential blank lines)
(removed link to deleted function page summary.m (removed per IK instruction 2026-08-30))
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
{{DISPLAYTITLE:function.m}}
+
{{DISPLAYTITLE:exorcise.m}} __NOTOC__
 
Searches ''Spinach'' distribution folders for any functions that do not conform to the house style. Opens the first one and complains to the console.
 
Searches ''Spinach'' distribution folders for any functions that do not conform to the house style. Opens the first one and complains to the console.
  
Line 6: Line 6:
 
     exorcise(mode)
 
     exorcise(mode)
  
−
==Arguments==
+
==Parameters==
  
−
   mode  - 'online' (default) checks the documentation
+
   mode  - 'online' checks the documentation
−
             Wiki for the corrsponding page; 'offline'
+
             Wiki for the corresponding page; 'offline'
 
             skips the Wiki check  
 
             skips the Wiki check  
  
Line 19: Line 19:
  
 
==See also==
 
==See also==
−
[[smack.m]]
+
[[smack.m]], [[banner.m]], [[cacheman.m]], [[compile_mex.m]], [[dipolar.m]], [[existentials.m]], [[forum.m]], [[hebrew.m]], [[iseye.m]], [[patrol.m]], [[rearm.m]], [[report.m]], [[sniff.m]], [[symmetry.m]], [[tolerances.m]], [[wiki.m]], [[wipe_cache.m]], [[Kernel_utilities]]
  
 
''Version 2.2, authors: [[Ilya Kuprov]]''
 
''Version 2.2, authors: [[Ilya Kuprov]]''

Latest revision as of 10:12, 30 August 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' checks the documentation
           Wiki for the corresponding 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, banner.m, cacheman.m, compile_mex.m, dipolar.m, existentials.m, forum.m, hebrew.m, iseye.m, patrol.m, rearm.m, report.m, sniff.m, symmetry.m, tolerances.m, wiki.m, wipe_cache.m, Kernel_utilities

Version 2.2, authors: Ilya Kuprov