Skip to content

Documentation: unwrap examples#47

Merged
martinctc merged 18 commits into
mainfrom
docs/unwrap-dontrun-examples
Jan 18, 2021
Merged

Documentation: unwrap examples#47
martinctc merged 18 commits into
mainfrom
docs/unwrap-dontrun-examples

Conversation

@martinctc

@martinctc martinctc commented Jan 13, 2021

Copy link
Copy Markdown
Member

Summary

This branch unwraps examples for functions, especially where dontrun{} have been used where they are not necessary. There are several reasons for this:

  • This improves the documentation on the GitHub Pages site and usability of functions
  • This is one of the reasons required to pass CRAN review
  • Best practice - errors with functions are picked up in automated R CMD checks

Some significant refactoring have also been done in this PR, including making network_leiden() and network_louvain() as wrappers around network_p2p(). This is an "extended" fix for #38.

Changes

The changes made in this PR are:

  1. Examples are unwrapped for functions, removing dontrun{} where they are not necessary.
  2. Converted network_leiden() and network_louvain() to function wrappers around network_p2p(). There are no known breaking changes in the API.
  3. Updated the pull request template to simplify process for future pull requests.
  4. Housekeeping to remove all errors, warnings, and notes from R CMD checks.
  5. Update _pkgdown.yml to add the new article on identifying changes over time.

Check

  • All R CMD checks pass
  • roxygen2::roxygenise() has been run prior to merging to ensure that .Rd and NAMESPACE files are up to date.

Note

This fixes #12.

@martinctc martinctc self-assigned this Jan 13, 2021
@martinctc martinctc added the documentation Improvements or additions to documentation label Jan 13, 2021
@martinctc martinctc linked an issue Jan 13, 2021 that may be closed by this pull request
@martinctc martinctc added the refactor Code that neither fixes a bug nor changes feature label Jan 18, 2021
@martinctc martinctc marked this pull request as ready for review January 18, 2021 18:35
@martinctc martinctc merged commit f32cdcb into main Jan 18, 2021
@martinctc martinctc deleted the docs/unwrap-dontrun-examples branch January 18, 2021 22:25
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 refactor Code that neither fixes a bug nor changes feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: unwrap dontrun examples where not necessary

1 participant