Skip to content

Commit b802107

Browse files
committed
doc
1 parent 9684b63 commit b802107

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

AGENTS.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,13 @@ Key limitations to minimum Matlab version include:
2424
* R2018a: mfilename('fullpath') tells the full path to the matlab .m file currently running (empty for older Matlab)
2525
* R2019b: function argument validation block "arguments"
2626

27-
## GNU Octave compatibility
28-
29-
Numerous functions are also compatible with GNU Octave, but Octave is not a primary target of this project.
30-
In particular, using GNU Octave with functions having a backend as shown in [API.md](./API.md), directly use the "stdlib.sys" namespace as Octave doesn't have built-in strings yet to support auto-backend selection.
27+
Numerous functions are also compatible with GNU Octave.
3128

3229
## Dev Rules
3330

3431
These rules apply under the namespace "stdlib" (directory +stdlib/) and all its sub-namespaces (subdirectories +stdlib/+*).
3532

36-
- The code syntax must work for Matlab >= R2019b (preferably Matlab >= R2017b)
33+
- The code syntax must work for Matlab >= R2019b (preferably Matlab >= R2017a)
3734
- The code must not require any Matlab toolboxes, only base Matlab functionality
3835
- Prohibited to use Matlab factory function "isMATLABReleaseOlderThan()" as it is slow and not available for Matlab < R2020b. Instead we use stdlib.matlabOlderThan() which is like 200x faster than isMATLABReleaseOlderThan() and works for Matlab >= R2016b
3936
- When an exception is encountered, we generally desire that the code return an "empty" value of the appropriate type. In certain cases we may throw or rethrow an error.

Readme.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@ Matlab R2017a and newer:
2323
test_main
2424
```
2525

26+
For the functions compatible with GNU Octave:
27+
28+
```octave
29+
addpath(pwd)
30+
oruntests('+stdlib/')
31+
```
32+
2633
## External language backends
2734

2835
Our functions that aren't possible in native Matlab code are implemented using Matlab's no-compile

0 commit comments

Comments
 (0)