MeasureTransport / MeasureTransport/MParT

Docs for Python/Matlab

Open
#237 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bindings documentation
Dominant language
C++
Stars
18
Forks
5
PR merge metrics
No merged PRs in 30d

Description

The neat thing about making a separate repository for the Julia bindings is that it comes with its own opportunity to create auto-generated docs for functions that work a specific way in Julia compared to C++. With the advent of GPU bindings in Python, which generally use a prefix of d, as well as MapOptions (which is somewhat of a house of cards in all the bindings 😅 ), we should probably work towards having documentation on the website reflecting specific bindings. I don't mind consolidating my Julia docs onto Sphinx, if that's the move, but I just thought I'd open up the floor.

I suppose the best move is to create a new section, like "Installation", called "Bindings" or something. Each of the bindings could have a page in there with any oddities, quirks, or other remarkable comments on them about how to use the binding. Perhaps we could merge it with #135 and create a section on each page for how to develop for that binding, but that's a different issue. I'm seeking feedback here as well as new ideas.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the website's existing Installation section and the separate Julia binding documentation. Review the proposed Python and Matlab binding quirks, including GPU naming and MapOptions, then assess whether consolidating Julia docs onto Sphinx and adding a Bindings section covers the stated needs and the related idea in #135; done requires an agreed scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, julia, matlab, python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.