Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add basic object model documentation #10

Merged
merged 2 commits into from
May 9, 2015
Merged

Conversation

hsorby
Copy link
Contributor

@hsorby hsorby commented Apr 19, 2015

Start of work on the object model documentation. Possibly a better place to discuss issue #9 since we can make use of Github restructured text rendering.

@nickerso
Copy link
Contributor

  • typo: AbstradtLlbCellMLError
  • maybe typo: libcellml:format (should be libcellml::format?)
  • I prefer the camel case version of libCellML to be LibCellml :)

@agarny
Copy link
Contributor

agarny commented Apr 26, 2015

Agreed with the camel case version: I also prefer LibCellml.

@nickerso
Copy link
Contributor

nickerso commented May 5, 2015

I think this is sufficient to get on with those initial use-cases. And can now be merged in.

@jonc125
Copy link
Contributor

jonc125 commented May 8, 2015

+1 from me. It might be nice to have the source that was used to generate the diagrams as well though?

@jonc125 jonc125 mentioned this pull request May 8, 2015
@agarny
Copy link
Contributor

agarny commented May 9, 2015

I am mainly concerned with the diagram for the first use cases at this stage, so in that context I am mainly fine with the current diagram. Indeed, I am not sure how deserialize() works. Why does it return a string? Also, shouldn't it take a string as an input? Either a URI or the contents of a CellML file? Maybe I missed the point of that method?...

Otherwise, I agree with @jonc125 that it would be nice to have the source for the diagrams, if possible.

mirams added a commit that referenced this pull request May 9, 2015
Seems we're happy this is all a good start!
@mirams mirams merged commit 5f88ffb into cellml:develop May 9, 2015
nickerso pushed a commit that referenced this pull request Jun 24, 2019
Update to latest develop
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants