Add docstring for helper function

iBMLab · Nov 25, 2017 · cc77d25 · cc77d25
1 parent 61eefe8
commit cc77d25
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/.gitattributes b/.gitattributes
diff --git a/imap_utilities/imsqrmat.m b/imap_utilities/imsqrmat.m
@@ -1,5 +1,9 @@
 function [himgsc,hStrings] = imsqrmat(mat, varargin)
 % pretty display for small (near)square matrix
+% Usage: 
+% [himgsc,hStrings] = imsqrmat(mat)
+% [himgsc,hStrings] = imsqrmat(mat, TickXY)
+% [himgsc,hStrings] = imsqrmat(mat, TickX, TickY)
 %--------------------------------------------------------------------------
 % Copyright (C) iMap Team 2016
 
@@ -33,5 +37,5 @@
     'YTick',      1:size(mat,1),...
     'YTickLabel', TickY,...
     'TickLength', [0 0],...
-    'xdir','reverse','ydir','normal');
+    'xdir','normal','ydir','reverse');
 end