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

Check and update documentation #48

Closed
3 tasks done
karlb opened this issue Jan 3, 2022 · 2 comments
Closed
3 tasks done

Check and update documentation #48

karlb opened this issue Jan 3, 2022 · 2 comments
Assignees

Comments

@karlb
Copy link
Contributor

karlb commented Jan 3, 2022

To make Causing usable by people outside of RealRate, we provide documentation at

This documentation has been written a while ago and has only been updated sporadically. Read the documentation and look for the following problems (on the develop branch):

  • Is it understandable to new users (being able to use it is sufficient, no deep math understanding required)?
  • Is it up to date with the code base (general content should be ok, but check code samples and code references)?
  • Does the code yield the same results as shown in the documentation?
@salistha-shakya
Copy link
Contributor

Yes, the code is understandable to new users but it was supposed to give output in PNG and PDF file format whereas we are receiving SVG graph.

@karlb
Copy link
Contributor Author

karlb commented Jan 5, 2022

Yes, the code is understandable to new users but it was supposed to give output in PNG and PDF file format whereas we are receiving SVG graph.

That is an acceptable change. Please update the documentation to describe the current behavior.

@karlb karlb closed this as completed Jan 12, 2022
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