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

allow customization of '@family' prefix #830

Closed
kevinushey opened this issue Nov 29, 2018 · 5 comments
Closed

allow customization of '@family' prefix #830

kevinushey opened this issue Nov 29, 2018 · 5 comments
Labels

Comments

@kevinushey
Copy link
Contributor

@kevinushey kevinushey commented Nov 29, 2018

When using e.g.

#' @family foo

The documentation gets an entry in the seealso section as:

Other foo: <...>

I'd like to be able to customize the prefix, so that I could just write e.g.

#' @family Environment management

and just have a plain old:

Environment management: <...>

ie, without the Other: prefix. Does that seem sensible?

tl;dr: "Other:" isn't always a great prefix and I'd like to customize that somehow.

@kevinushey
Copy link
Contributor Author

@kevinushey kevinushey commented Nov 29, 2018

More generally, it would be 'nice' to be able to map family names (e.g. 'foo') to a particular prefix / label for when that set of functions are rendered.

@hadley
Copy link
Member

@hadley hadley commented Jul 20, 2019

I think this is a reasonable request, but I just don't see where you'd define the lookup. If you can think of a reasonable place to store that data, I'd consider implementing it.

@hadley hadley added the feature label Jul 20, 2019
@kevinushey
Copy link
Contributor Author

@kevinushey kevinushey commented Jul 22, 2019

How would you feel about a subfolder like meta-roxygen that encoded this in some way? E.g. we could have meta-roxygen/family.json and we could map family names to prefixes there. (or it could just be an .R file, or some other appropriate representation)

@hadley
Copy link
Member

@hadley hadley commented Jul 22, 2019

I wonder if we could put that in man/ or man/roxygen?

@kevinushey
Copy link
Contributor Author

@kevinushey kevinushey commented Jul 22, 2019

I like man-roxygen. I'll prototype something.

kevinushey added a commit to kevinushey/roxygen that referenced this issue Jul 22, 2019
kevinushey added a commit to kevinushey/roxygen that referenced this issue Jul 22, 2019
kevinushey added a commit to kevinushey/roxygen that referenced this issue Jul 22, 2019
@hadley hadley closed this in 5d99c2d Jul 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants