Skip to content

Commit

Permalink
[doc]
Browse files Browse the repository at this point in the history
Some links in README etc were using the old `doc-project/` directory name, which was merged in to `docs/` so it could be used with GitHub Pages publishing from the master branch. And a couple of the links were missing the `user-guide/` directory element under that.

Also tweaked the Markdown formatting in Design-and-Justification to make markdownlint happy.
  • Loading branch information
apjanke committed Jan 29, 2024
1 parent 5eb6469 commit a7c2492
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,16 +49,15 @@ If you want to hack on the Tablicious code itself, set it up like this:
Once you have Tablicious installed, the user manual will show up in the Octave GUI’s documentation browser.
You can also run `help <foo>` or `doc <foo>` for any of the classes or functions in Tablicious.

The documentation for the latest development version can be viewed online at <https://apjanke.github.io/octave-tablicious/doc/tablicious.html>.
The documentation for the latest development version can be viewed online at <https://apjanke.github.io/octave-tablicious/user-guide/tablicious.html>.

See the `doc-project/` directory for notes on this project, especially for [Developer Notes](doc-project/Developer-Notes.md) and [Design and Justification](doc-project/Design-and-Justification.md), which discusses how and why this library is written.
Also see [CONTRIBUTING](CONTRIBUTING.md) if you would like to contribute to this project.
See the `docs/` directory for notes on this project, especially for [Developer Notes](docs/Developer-Notes.md) and [Design and Justification](docs/Design-and-Justification.md), which discusses how and why this library is written. Also see [CONTRIBUTING](CONTRIBUTING.md) if you would like to contribute to this project.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.

### No Matlab usage!
### No Matlab Usage

To avoid issues with the Matlab license's Non-Compete clause, this project needs to be developed entirely using Octave, and not using Matlab at all, including for testing or benchmarking purposes. Please do not submit any Matlab test or benchmark results, or any code produced using Matlab. And if you know anything about how the Matlab internals work, please do not tell me!

Expand Down
8 changes: 3 additions & 5 deletions docs/Design-and-Justification.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ This document describes the design choices I made in Tablicious, and some
justifications for them and why I think they should be allowed into core
Octave, or at least an Octave Forge package.

# Design

## Objects

### Copy constructors
Expand Down Expand Up @@ -147,9 +145,9 @@ I’m thinking about breaking the `load` step out into separate `load_raw`
and `munge` steps, to make it easier for users to view the example
dataset code and see how the data-packaging classes like `table` are used.

# Justification
## Justification

## Why does `table` display differently than in Matlab?
### Why does `table` display differently than in Matlab?

In Matlab, doing `disp()` on a `table` will result in its printing the
entire table contents in tabular form, as it does with primitives and
Expand All @@ -164,7 +162,7 @@ each way, and found the summary style to be much more usable.

I think this is fine because `disp()` is mostly used for interactive use, and is not frequently used to produce actual program output, so this shouldn't be a real compatibility issue.

## Justify all these new top-level functions
### Justify all these new top-level functions

Tablicious defines several new top-level (global, not in namespaces or
`private/` directories) functions. Many of them are ports of Matlab
Expand Down
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Tablicious Online Documentation

This is the documentation site for Tablicious.

Tablicious is a package for GNU Octave that provides relational data structures for Octave. It includes implementations of `table` arrays, `datetime`, `string`, `categorical`, and some other related stuff. You can think of it as "pandas for Octave".
Expand Down

0 comments on commit a7c2492

Please sign in to comment.