Skip to content

Commit

Permalink
Update File Exchange text
Browse files Browse the repository at this point in the history
  • Loading branch information
apjanke committed Jan 29, 2020
1 parent 59d0b43 commit ea8dfd9
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion doc/Text for File Exchange.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,17 @@ Matlab does not provide a general, polymorphic object display function, like Jav

The Dispstr API provides a concise API for generic, polymorphic, customizable object display, and implementations for the major types that come with Matlab.

Dispstr only provides a few functions and classes: dispstr(), dispstrs(), prettyprint(), sprintfds(), fprintfds(), and dispstrlib.Displayable. dispstr() and disptrs() are generic object display functions, which can be overridden by user-defined classes to customize their display. prettyprint() is a function for dumping the details of an array, and respects dispstr/dispstrs. sprintfds() and fprintfds() let you do formatted output that respects dispstr(). @dispstrlib.Displayable is a convenience mixin that makes it easier to write classes that implement dispstr/dispstrs.
Dispstr only provides a few functions and classes:

dispstr() and dispstrs()

prettyprint()

sprintfds(), fprintfds(), errords(), and warningds()

dispstrlib.Displayable and dispstrlib.DisplayableHandle

dispstr() and disptrs() are generic object display functions, which can be overridden by user-defined classes to customize their display. prettyprint() is a function for dumping the details of an array, and respects dispstr/dispstrs. sprintfds() and fprintfds() let you do formatted output that respects dispstr(). errords() and warningds() are variants of error() and warning() that respect dispstr formatting. And @dispstrlib.Displayable is a convenience mixin that makes it easier to write classes that implement dispstr/dispstrs.

When using this library, your user-defined objects can now be displayed inside structs and tables with meaningful data representations, instead of just "<1-by-1 SomeClass>", which Matlab's default disp() does when objects are stuck inside fields of cells or variables of tables.

Expand Down

0 comments on commit ea8dfd9

Please sign in to comment.