Skip to content

Commit

Permalink
Fix indentation in function docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
ehennestad committed Dec 6, 2024
1 parent f989984 commit 8aa83c3
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 25 deletions.
24 changes: 12 additions & 12 deletions generateCore.m
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@ function generateCore(version, options)
% GENERATECORE - Generate Matlab classes from NWB core schema files
%
% Syntax:
% GENERATECORE() Generate classes (Matlab m-files) from the
% NWB core namespace file. By default, generates off of the most recent
% nwb-schema release.
% GENERATECORE() Generate classes (Matlab m-files) from the
% NWB core namespace file. By default, generates off of the most recent
% nwb-schema release.
%
% GENERATECORE(version) Generate classes for the
% core namespace of the listed version.
% GENERATECORE(version) Generate classes for the
% core namespace of the listed version.
%
% GENERATECORE(__, Name, Value) Generate classes based on optional
% name-value pairs controlling the output .
% GENERATECORE(__, Name, Value) Generate classes based on optional
% name-value pairs controlling the output .
%
% A cache of schema data is generated in the ``namespaces`` subdirectory in
% the matnwb root directory. This is for allowing cross-referencing
% classes between multiple namespaces.
% A cache of schema data is generated in the ``namespaces`` subdirectory in
% the matnwb root directory. This is for allowing cross-referencing
% classes between multiple namespaces.
%
% Output files are placed in a ``+types`` subdirectory in the
% matnwb root directory directory.
% Output files are placed in a ``+types`` subdirectory in the
% matnwb root directory directory.
%
% Usage:
% Example 1 - Generate core schemas for the latest version of NWB::
Expand Down
16 changes: 8 additions & 8 deletions generateExtension.m
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@ function generateExtension(namespaceFilePath, options)
% GENERATEEXTENSION - Generate Matlab classes from NWB extension schema file
%
% Syntax:
% GENERATEEXTENSION(extension_path...) Generate classes (Matlab m-files)
% from one or more NWB schema extension namespace files. A registry of
% already generated core types is used to resolve dependent types.
% GENERATEEXTENSION(extension_path...) Generate classes (Matlab m-files)
% from one or more NWB schema extension namespace files. A registry of
% already generated core types is used to resolve dependent types.
%
% A cache of schema data is generated in the ``namespaces`` subdirectory in
% the matnwb root directory. This is for allowing cross-referencing
% classes between multiple namespaces.
% A cache of schema data is generated in the ``namespaces`` subdirectory in
% the matnwb root directory. This is for allowing cross-referencing
% classes between multiple namespaces.
%
% Output files are placed in a ``+types`` subdirectory in the
% matnwb root directory directory.
% Output files are placed in a ``+types`` subdirectory in the
% matnwb root directory directory.
%
% Input Arguments:
% - namespaceFilePath (string) -
Expand Down
4 changes: 2 additions & 2 deletions nwbClearGenerated.m
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
% NWBCLEARGENERATED - Clear generated class files.
%
% Syntax:
% NWBCLEARGENERATED() Clear generated class files from the ``+types``
% folder in the matnwb root directory.
% NWBCLEARGENERATED() Clear generated class files from the ``+types``
% folder in the matnwb root directory.
%
% Input Arguments:
% - targetFolder (string) -
Expand Down
2 changes: 1 addition & 1 deletion nwbExport.m
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ function nwbExport(nwbFileObjects, filePaths, mode)
%NWBEXPORT - Writes an NWB file.
%
% Syntax:
% NWBEXPORT(nwb, filename) Writes the nwb object to a file at filename.
% NWBEXPORT(nwb, filename) Writes the nwb object to a file at filename.
%
% Input Arguments:
% - nwb (NwbFile) - Nwb file object
Expand Down
4 changes: 2 additions & 2 deletions nwbRead.m
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
%
% - flags (string) -
% Flag for setting the mode for the NWBREAD operation. Available options are:
% 'ignorecache'. If the 'ignorecache' flag is used, classes for NWB data types
% are not re-generated based on the embedded schemas in the file.
% 'ignorecache'. If the 'ignorecache' flag is used, classes for NWB data
% types are not re-generated based on the embedded schemas in the file.
%
% - options (name-value pairs) -
% Optional name-value pairs. Available options:
Expand Down

0 comments on commit 8aa83c3

Please sign in to comment.