Skip to content

Formatting of the returned variables in the API #48

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.

Sign up for GitHub

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

Jump to bottom
Open
ManuelRatz opened this issue Apr 8, 2025 · 0 comments · May be fixed by #53
Open

Formatting of the returned variables in the API #48

ManuelRatz opened this issue Apr 8, 2025 · 0 comments · May be fixed by #53

Comments

@ManuelRatz
Copy link

This is part of the review for the joss paper openjournals/joss-reviews#7873

The formatting in the API return of the functions returning dicts are very messsy. I recommend to use dashes or another form of subindexing. Also, for the claculate_* functions, the full dict is explained while for the generate_* functions (which are used by the user), they are not.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

48 formatting of the returned variables in the api cassidymwagner/fluidsf
1 participant
@ManuelRatz