Anonymous avatar Anonymous committed 083ff87

add doc about *** wildcards

Comments (0)

Files changed (2)

-  DOCTEST
+DOCTEST
   Run examples embedded in documentation
  
   doctest func_name
   Save that to 'add7.m'.  Now you can say 'doctest add7' and it will run
   'add7(3)' and make sure that it gets back 'ans = 10'.
  
+  If the output of some function will change each time you call it, for
+  instance if it includes a random number, you can put *** (three
+  asterisks) where the changing element should be.  This acts as a
+  wildcard, and will match anything.
  
   LIMITATIONS:
  
   because I haven't found a good way to mark these subsequent lines as
   part-of-the-source-code rather than part-of-the-result.
   
-
 % Save that to 'add7.m'.  Now you can say 'doctest add7' and it will run
 % 'add7(3)' and make sure that it gets back 'ans = 10'.
 %
+% If the output of some function will change each time you call it, for
+% instance if it includes a random number, you can put *** (three
+% asterisks) where the changing element should be.  This acts as a
+% wildcard, and will match anything.
 %
 % LIMITATIONS:
 %
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.