Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unclutter documentation index #59

Closed
krlmlr opened this issue Nov 11, 2015 · 7 comments
Closed

Unclutter documentation index #59

krlmlr opened this issue Nov 11, 2015 · 7 comments
Assignees
Labels
Milestone

Comments

@krlmlr
Copy link
Member

krlmlr commented Nov 11, 2015

Example:

dbHasCompleted Has the operation completed?
dbHasCompleted-method Has the operation completed?

One of these should go away.

@hadley
Copy link
Member

hadley commented Nov 11, 2015

I'm not sure that's possible :/

@krlmlr
Copy link
Member Author

krlmlr commented Nov 11, 2015

What happens (apart from the desired effect) if we ditch the alias that seems to generate this?

https://github.com/rstats-db/DBI/blob/7a0ad76dea21a846cee62f67108ab8e8b7d60a49/R/DBResult.R#L161

@hadley
Copy link
Member

hadley commented Nov 11, 2015

You get an error that the S4 method isn't documented.

We could possibly alias all the methods to a dummy help doc with @keyword internal, but that would break methods?dbHasCompleted.

@hadley
Copy link
Member

hadley commented Nov 11, 2015

FWIW with latest roxygen, I think you can use @rdname instead of manually creating the aliases.

@krlmlr
Copy link
Member Author

krlmlr commented Nov 11, 2015

Thanks, I forgot about R CMD check. FWIW, methods?dbHasCompleted" seems to be broken.

> methods?dbHasCompleted
Error in `?`(methods, dbHasCompleted) : 
  no documentation of type ‘methods’ and topic ‘dbHasCompleted’ (or error in processing help)
2: stop(gettextf("no documentation of type %s and topic %s (or error in processing help)", 
       sQuote(type), sQuote(topicExpr)), domain = NA)
1: `?`(methods, dbHasCompleted)

@hadley
Copy link
Member

hadley commented Nov 11, 2015

Sorry, I always forget how you look up methods - it should be ?dbConnect(RSQLite::SQLite()) or similar.

@krlmlr
Copy link
Member Author

krlmlr commented Nov 11, 2015

It's strange that I don't get R CMD check errors on R 3.2.2 -- dbConnect() doesn't have the required alias, no duplicate entry in the index, still ?dbConnect(RSQLite::SQLite()) works (and ?dbConnect("a") doesn't).

@krlmlr krlmlr modified the milestone: 0.5 Jul 6, 2016
@krlmlr krlmlr modified the milestones: 0.6, 0.5 Jul 31, 2016
@krlmlr krlmlr self-assigned this Jul 31, 2016
@krlmlr krlmlr closed this as completed in e8d8442 Aug 1, 2016
@krlmlr krlmlr removed the in progress label Aug 1, 2016
krlmlr pushed a commit that referenced this issue Aug 1, 2016
- Clean up documentation.
    - Direct S4 documentation to a hidden page to unclutter documentation index (#59).
    - Export `dbFetch()` and `dbQuoteString()` methods.
    - Add package documentation.
    - Remove full stop from documentation titles.
    - Minor documentation fixes.
- Fix two minor vignette typos (#124, @mdsumner).
krlmlr added a commit that referenced this issue Aug 11, 2016
- Interface changes
    - `dbDataType()` maps `character` values to `"TEXT"` by default (#102).
    - The default implementation of `dbQuoteString()` doesn't call `encodeString()` anymore: Neither SQLite nor Postgres understand e.g. `\n` in a string literal, and all of SQLite, Postgres, and MySQL accept an embedded newline (#121).

- Interface enhancements
    - New `dbSendStatement()` generic, forwards to `dbSendQuery()` by default (#20, #132).
    - New `dbExecute()`, calls `dbSendStatement()` by default (#109, @bborgesr).
    - New `dbWithTransaction()` that calls `dbBegin()` and `dbCommit()`, and `dbRollback()` on failure (#110, @bborgesr).
    - New `dbBreak()` function which allows aborting from within `dbWithTransaction()` (#115, #133).
    - Export `dbFetch()` and `dbQuoteString()` methods.

- Documentation improvements:
    - One example per function (except functions scheduled for deprecation) (#67).
    - Consistent layout and identifier naming.
    - Better documentation of generics by adding links to the class and related generics in the "See also" section under "Other DBI... generics" (#130). S4 documentation is directed to a hidden page to unclutter documentation index (#59).
    - Fix two minor vignette typos (#124, @mdsumner).
    - Add package documentation.
    - Remove misleading parts in `dbConnect()` documentation (#118).
    - Remove misleading link in `dbDataType()` documentation.
    - Remove full stop from documentation titles.
    - New help topic "DBIspec" that contains the full DBI specification (currently work in progress) (#129).
    - HTML documentation generated by `staticdocs` is now uploaded to http://rstats-db.github.io/DBI for each build of the "production" branch (#131).
    - Further minor changes and fixes.

- Internal
    - Use `contains` argument instead of `representation()` to denote base classes (#93).
    - Remove redundant declaration of transaction methods (#110, @bborgesr).
@github-actions github-actions bot locked and limited conversation to collaborators Oct 8, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants