DOC: Documentation for Function Class Usage #465
Conversation
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## develop #465 +/- ##
===========================================
- Coverage 70.87% 70.85% -0.02%
===========================================
Files 55 55
Lines 9223 9227 +4
===========================================
+ Hits 6537 6538 +1
- Misses 2686 2689 +3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
docs/user/function.rst
Outdated
| .. note:: | ||
| Compare the interpolation and extrapolation effects by changing their methods. Check out this plot results with ``linear`` interpolation and ``constant`` extrapolation and see their difference. |
There was a problem hiding this comment.
The documentation would feel more complete if you showed the diference of the interpolations here. At least of the linear case
docs/user/function.rst
Outdated
| Furthermore, the :meth:`rocketpy.Function.get_value` method can be used to get a list of outputs from a list of inputs: | ||
|
|
||
| .. jupyter-execute:: | ||
|
|
||
| print(f.get_value([1, 4, 9, 16, 25])) | ||
|
|
There was a problem hiding this comment.
This can be done with the call method too I believe. This is not clear here
| b. Function Arithmetic | ||
| ~~~~~~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
This is missing mentioning all the arthmetic operations that can be done. A simple listing would be fine
|
|
||
| d. Differentiation and Integration | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
There was a problem hiding this comment.
Does everything here work with 2D or higher dimension Functions?
Same question for the Discretization section
|
Also, please add mentions of this page in other pages of the docs. Mentioning Function usage in the Export Data section of the First simulation Page is a must |
Pull request type
What is New
This PR introduces
Functionclass documentation page. Afunction.rstfile was created containing:Functionclass functionalities;Functiondata sources;Functionresults (e.g. interpolation);Breaking change
Additional information
Notice that this PR includes the branch of #451 since it contains a necessary fix to 2D plots.