Comments (5)
Before 2012b, the html-based documentation for user-created toolboxes was treated almost the same way as for standard toolboxes. Now they put them on a separate page. My quick survey of people's use of matlab documentation was that people mostly used help
and doc
commands or google, rarely resorting to matlab's html documentation. So I thought that the HTML documentation was not worth the effort. I would just provide links to the online documentation from the help text.
from datajoint-matlab.
I like the idea of integrating links to the wiki into the code documentation. We could also create a stub in Matlab's documentation system that points to the wiki. Personally, I find it very unfortunate that Mathworks is now hiding the documentation for user toolboxes on a separate page. It took me a while to find it in the recent release.
from datajoint-matlab.
I have also considered using the same approach as PsychToolbox. Instead of using matlab's documentation tools, we could use a special command, e.g. dj.help
as the starting point to tutorials.
from datajoint-matlab.
I vote for having the documentation online and only there. Makes it most widely accessible while having to maintain only one documentation and makes it agnostic to whatever Mathworks comes up with in future versions of Matlab.
from datajoint-matlab.
Closing. All documentation will be online.
from datajoint-matlab.
Related Issues (20)
- Markdown not properly rendered in FEX Toolbox description
- fetchn(tableA * tableB, 'field') does not work in 3.4.2
- del deletes some incorrect entries from downstream tables with renamed foreign keys HOT 1
- table classes on path was not recognized when deleting or populating
- error with fetchn DataJoint version 3.4.2 HOT 1
- `{}` is not supported in attribute comments HOT 1
- bool and boolean is not supported in 3.4.1 HOT 1
- Parallelize file transfer for external blobs HOT 1
- bug with del() HOT 6
- Occasional fwrite errors using file-based stores
- fetching 'KEY' error HOT 2
- discovering existing tables across python/matlab HOT 5
- Empty matrices are converted to NULL HOT 2
- syncDef missing [nullable] & comment properties HOT 2
- Officially use the `+` operator for unions
- SSL Connection error HOT 2
- Schema name must start with lower case HOT 2
- Allow strings as well as char HOT 2
- MATLAB hangs and ramps up CPU usage if user closes the password Diagloue Box
- Allow pasting when logging into a database
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from datajoint-matlab.