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

Clarify the api #33

Open
11 tasks
LecrisUT opened this issue Jun 9, 2023 · 2 comments
Open
11 tasks

Clarify the api #33

LecrisUT opened this issue Jun 9, 2023 · 2 comments

Comments

@LecrisUT
Copy link
Contributor

LecrisUT commented Jun 9, 2023

It is not so clear what the api for the dictionary and variable are. Ideally there should be a table matching the C++/Python interface to the fortran one. Basic API that should be documented:

  • Constructor
  • Adding a kv pair. If it already exists error/throw
  • Assigning a value to a key. If it doesn't exist error/throw
  • Add or assign
  • Get value
  • Delete key (deleting pointer or not)
  • Delete dictionary (deleting pointer or not)
  • Pop key
  • Itteration
  • Get size
  • Check if key exist

Those are dictionary, but for variable, that does not have a clear C++/Python counterpart, so I'm not sure what needs to be documented.

@zerothi
Copy link
Owner

zerothi commented Jun 9, 2023

I agree, this was largely a small library that I never got around to document heavily. But clearly it should be :)

Due to the small size I put small examples in the README.md, but even that isn't complete.

@LecrisUT
Copy link
Contributor Author

LecrisUT commented Jun 9, 2023

I would first suggest that the README.md to only have a simple mwe example and move other documentation to a proper markdown page that can be rendered in ReadTheDocs. (Not sure how well doxygen for fortran is working these days).

Otherwise, the documentation in the README.md is still confusing, e.g. it is not clear that assign is usable for dictionary as well as variable.

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

No branches or pull requests

2 participants