Difference between revisions of "Exorcise.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Update function See also links and function index membership)
(sync with Spinach main f053e432: mode argument no longer has a default; typo fix)
Line 8: Line 8:
 
==Parameters==
 
==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  
  

Revision as of 06:43, 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, summary.m, symmetry.m, tolerances.m, wiki.m, wipe_cache.m, Kernel_utilities

Version 2.2, authors: Ilya Kuprov