Skip to content

Conversation

@csouchet
Copy link
Contributor

@csouchet csouchet commented Oct 26, 2022

Improve API documentation
Add executable examples

covers #10

@csouchet csouchet added the documentation Improvements or additions to documentation label Oct 26, 2022
@tbouffard tbouffard changed the title [DOC] Update doc [DOC] Improve the documentation to better match CRAN requirements Oct 26, 2022
csouchet and others added 3 commits October 27, 2022 09:21
Co-authored-by: Souchet Céline <4921914+csouchet@users.noreply.github.com>
Co-authored-by: Souchet Céline <4921914+csouchet@users.noreply.github.com>
@tbouffard
Copy link
Member

⚠️ let's regenerate the Rd files and push them if needed. There is a risk that they are out-dated comparing to the source code

@csouchet csouchet marked this pull request as ready for review October 27, 2022 08:52
@csouchet csouchet requested a review from tbouffard October 27, 2022 08:52
Copy link
Member

@tbouffard tbouffard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, good job (in pair 😄)!

@csouchet csouchet merged commit 116ce1f into main Oct 27, 2022
@csouchet csouchet deleted the update_doc branch October 27, 2022 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants