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

Documentation #1

Closed
szaghi opened this issue Oct 22, 2015 · 5 comments
Closed

Documentation #1

szaghi opened this issue Oct 22, 2015 · 5 comments

Comments

@szaghi
Copy link

szaghi commented Oct 22, 2015

Hi Adriano,

I follow your progress with interest, I think this project has great potential. However, the lack of documentation limits me (and maybe others) to digg deeper. I am counscious that writing documentation is a time-consuming effort, but it has not less relevance of the code itself (IMHO). Have you a plan to add documentation in the near future (or it is already here and I am so blind to have missed it)?

Thank you very much for sharing your work.

Stefano

@aamaricci
Copy link
Collaborator

Hi Stefano,
thanks for your interest.

You're right about the missing documentation.
This is a feature I'd like to add. I mean it is in the todo list, together with other extensions I have in my pipeline (sparse matrices, sparse linalg, ode solvers, a better interface to quadpack, etc.).

In any case my plan for the future would be to use FORD. I played a bit with other tools, but this one looks pretty nice and well suited for SciFor.

This, and the aforementioned extensions, could be an excellent basis for a collaborative work, but on the other hand I understand that with no documentation whatsoever that's kind of desperate act (and the main reason why I did not deployed the library to FOSS).

Cheers,
A

@szaghi
Copy link
Author

szaghi commented Oct 22, 2015

@aamaricci Great! Happy to read this! FORD is really a cool tool.

I will continue to track this project.

See you soon.

@szaghi szaghi closed this as completed Oct 22, 2015
@funnell
Copy link

funnell commented Nov 15, 2015

Just to chime in, I'm also interested in this project. But, without documentation it's difficult to get started...

@aamaricci
Copy link
Collaborator

Hi. Thanks for your interest.
I should definitively start working on that.
A

@band-a-prend
Copy link
Contributor

I'm also interested in documentation as the first looked example for python scipy as reference for this project used lambda function passed into.

E.g. it was general integration (quad): https://docs.scipy.org/doc/scipy/reference/tutorial/integrate.html

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

4 participants