Skip to content

Consistent @command args... syntax for all special character strings #65

Closed

Description

@gadenbuie

I like the @news pkg {optional_search} syntax. It does make me wonder if, rather than curly quotes with{dplyr}, we ought to support @pkg dplyr. This would align with the tidy style convention of no special formatting for package names, bring this syntax a little closer to other btw shorthands, and bring the syntax a little closer to e.g. Positron Assistant participants. (This argument could also go for @help topic instead of ?topic, etc, so that folks would only need to remember the @ keyword to use shorthands with btw. Maybe this should be spun off into a more general issue.)

Originally posted by @simonpcouch in #64 (review)

btw("{dplyr}") # now
btw("@pkg dplyr") # and also

btw("?dplyr::across") # now
btw("@help dplyr across") # and also
btw("@help dplyr::across") # also also

# etc...

Activity

  1. changed the title [-]Consistent `@command args` syntax for all special character strings[/-] [+]Consistent `@command args...` syntax for all special character strings[/+] on May 29, 2025
  2. gadenbuie commented on Oct 22, 2025

    @gadenbuie
    CollaboratorAuthor

    Also btw("@README.md") or btw("@R/source-file.R") to inline file contents into the chat context. Markdown files would be inlined without decoration, other files would be wrapped in code blocks

  3. added this to the v1.0.0 milestone on Oct 22, 2025
  4. self-assigned this
    on Oct 22, 2025
  5. gadenbuie commented on Oct 22, 2025

    @gadenbuie
    CollaboratorAuthor

    Also btw("@README.md") or btw("@R/source-file.R") to inline file contents into the chat context. Markdown files would be inlined without decoration, other files would be wrapped in code blocks

    Oops, this is already supported with btw("./README.md")

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions