simula_cbc / cbcflow / issues / #29 - Write documentation of user-level interfaces — Bitbucket

Issue #29 resolved

Martin Sandve Alnæs created an issue 2014-01-23

At least the core interfaces NSProblem, NSPostProcessor, NSSolver, NSScheme.

Follow the guidelines at http://fenicsproject.org/contributing/styleguide_doc.html#styleguide-documentation

Comments (8)

Martin Sandve Alnæs reporter
Issue ~~#12~~ was marked as a duplicate of this issue.
- 2014-01-23T12:02:34+00:00
Martin Sandve Alnæs reporter
- removed version
- 2014-01-23T13:16:47+00:00
Martin Sandve Alnæs reporter
I've started on the problem interface.
- 2014-01-28T14:58:22+00:00
Martin Sandve Alnæs reporter
- assigned issue to
  
  Martin Sandve Alnæs
- 2014-01-28T14:58:40+00:00
Øyvind Evju
Have you done something on this?
- 2014-02-14T15:23:40+00:00
Martin Sandve Alnæs reporter
No.
- 2014-02-14T16:12:19+00:00
Øyvind Evju
Only lacking NSScheme. How detailed should the documentation of this be? It can be quite cumbersome to handle all the variants and helper functions properly. If someone wants to implement their own scheme, I would imagine that they would use another scheme as template. I'm leaning towards little details in this, at least for now...

To use a specific scheme I guess it would be sufficient to document the parameters, but we should also document the method as well.
- 2014-02-18T14:09:56+00:00
Øyvind Evju
- changed status to resolved
Sort of resolved, although it wouldn't hurt to expand it.
- 2014-12-03T12:19:41+00:00
Log in to comment

Assignee: Martin Sandve Alnæs

Type: task

Priority: major

Status: resolved

Milestone: 1.3

Version: –

Votes: 0

Watchers: 2

Jira: the preferred issue tracker for Bitbucket. Join the team!