Documentation Corrections

dtamayo / reboundx

A library for adding additional forces to the REBOUND N-body integration package

GNU General Public License v3.0

80 stars 60 forks source link

Documentation Corrections #46

Closed sabaronett closed 1 year ago

sabaronett commented 4 years ago

Ambiguous target URL in last paragraph of https://reboundx.readthedocs.io/en/latest/add_effect.html#c-example:

(See Sec. 2.4 of OpenGL Keyboard Commands for a list of the visualization keyboard commands)

Unable to find possible original source for link thus far.

4/13/2020 Update: Resolved in 542f3a490cb25eee8c98561121cbf790db7a6ea0

sabaronett commented 4 years ago

Header comment to examples/modify_mass/problem.c is identical/taken from /modify_orbits. https://github.com/dtamayo/reboundx/blob/b5e35b4eeed8b6b25978d2f087cb535c8bedbbc8/examples/modify_mass/problem.c#L1-L9

Leads to the following issues with online documentation:

And § 5.8, title and description here

4/13/2020 Update: Resolved in 542f3a490cb25eee8c98561121cbf790db7a6ea0

sabaronett commented 4 years ago

All standing issues resolved.

Closing.

sabaronett commented 4 years ago

@dtamayo, I found some issues on the readthedocs page after #47. I should have compiled and proofread the HTML pages after https://github.com/sabaronett/reboundx/pull/25. Let me know if you'd like me to help fix any of these on a new branch in my fork and submit a PR.

[ ] https://reboundx.readthedocs.io/en/latest/index.html#attribution
[ ] The following lines appear to be split. https://reboundx.readthedocs.io/en/latest/c_api.html#_CPPv411rebx_timing
[ ] rebx_binary_field_type, rebx_input_binary_messages, rebx_integrator, and rebx_interpolation_type, all appear to list int values without their enumerated element names.

dtamayo commented 4 years ago

Thanks Stanley,

I thought giving an example in latex like people would use would be simpler, though I agree it looks quite ugly :) Happy to be convinced otherwise.

And thanks for catching those others. There's still some work to do on documenting the C code. I'll leave this open to remind myself.

jiayindong commented 3 years ago

On the Implemented Effects page, Section 1.1.2 modfiy_orbits_direct, Effect parameter "If p is not set, it defaults to 1." It seems the default p is 0. Feel free to correct me if I'm wrong. Thanks!

dtamayo commented 3 years ago

Thanks DJ! Sorry for the slow response--this somehow fell through the cracks. You are absolutely right. I've updated the documentation accordingly