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

function signatures inaccurate #233

Open
pavelkomarov opened this issue Oct 1, 2024 · 4 comments
Open

function signatures inaccurate #233

pavelkomarov opened this issue Oct 1, 2024 · 4 comments

Comments

@pavelkomarov
Copy link

There are numerous typos in the docs. I should have been keeping a more careful list. This one is an actual function signature that was never updated, looks like.

http://www.clawpack.org/pyclaw/io.html has read_<format> and write_<format>, but the actual way things are read and written is via clawpack.pyclaw.fileio.<format>.read and clawpack.pyclaw.fileio.<format>.write. grep is giving me nothing for read_ascii, for example.

@ketch
Copy link
Member

ketch commented Oct 1, 2024

I'm not sure what the "issue" here. Is there a specific bit of code you wrote that doesn't work like the documentation says it should?

@pavelkomarov
Copy link
Author

The docs are out of sync with the code.

@ketch
Copy link
Member

ketch commented Oct 1, 2024

Again, please give a minimal working (or non-working) example.

@mandli
Copy link
Member

mandli commented Oct 1, 2024

I would point out that the documentation is not really wrong as it is just describing the signature. I do think it used to work to call the read/write functions that way but the canonical way to actually read/write something is to either instantiate a Solution object and give it the file format or call Solution.write or Solution.read and hand those functions the file format. You could call the clawpack.pyclaw.fileio.<format>.write function but that is not generally recommended.

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

3 participants