Giter Club home page Giter Club logo

rdoc's People

Contributors

mdequeljoe avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

rdoc's Issues

Does not work with namespace::

In a fresh R session:

> rdoc::rdoc(MASS::bcv)
Error in dirname(path) : a character vector argument expected

It works nicely once the package is loaded:

> library(MASS)
> rdoc::rdoc(bcv)

utils might shadow rdoc, if loaded later

Not sure what to do about this, maybe rdoc could depend on utils, but maybe you could just document it in the README?

I.e. to make sure rdoc is used I have this in the profile:

library(utils)
rdoc::use_rdoc()

Provide an option for custom link formatting

First of all, this is an awesome update to the default pager. Bravo.

I noticed that you currently leave links in the markdown format. While this is somewhat useful, I was wondering if there was a way that we could also suppress it to get back to the bare approach provided by the default pager.

Thanks!

Think about rearranging sections

A frequent complaint about R documentation is that the examples are at the very end of the documentation, and often people learn best by example.

Perhaps rdoc could move the examples section to just below the description? Maybe controllable by an option if people want to preserve the default ordering.

"?" name collision with devtools/pkgload

This is maybe not sg that should be fixed here, but in pkgload, just wanted to make note of it. pkgload also has ?, to render development documentation, and this overrides rdoc.

@jimhester do you think that there is an easy workaround for this?

line breaks in \preformatted

I have this:

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/pkg-dependencies.R
\name{pkg_deps}
\alias{pkg_deps}
\title{R6 class for package dependency lookup}
\description{
Create a \code{pkg_deps} object to look up dependencies of R packages.
}
\details{
The usual steps to query package dependencies are...
}
\section{Methods}{\preformatted{pkg_deps$new()
pkg_deps$get_refs()
pkg_deps$get_config()
pkg_deps$resolve()
pkg_deps$async_resolve()
pkg_deps$get_resolution()
pkg_deps$solve()
pkg_deps$get_solution()
pkg_deps$draw()
pkg_deps$format()
pkg_deps$print()
}
}

and utils::help() formats it correctly:

...
Methods:

     pkg_deps$new()
     pkg_deps$get_refs()
     pkg_deps$get_config()
     pkg_deps$resolve()
     pkg_deps$async_resolve()
     pkg_deps$get_resolution()
     pkg_deps$solve()
     pkg_deps$get_solution()
     pkg_deps$draw()
     pkg_deps$format()
     pkg_deps$print()
...

But rdoc removes the newlines for some reason:

Methods

     pkg_deps$new() pkg_deps$get_refs() pkg_deps$get_config() pkg_deps$resolve() pkg_deps$async_resolve()
     pkg_deps$get_resolution() pkg_deps$solve() pkg_deps$get_solution() pkg_deps$draw() pkg_deps$format()
     pkg_deps$print()

Any ideas? Thanks!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.