-
Notifications
You must be signed in to change notification settings - Fork 334
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
bogus link if missing BugReports #855
Comments
Could be merged with #694 |
I could prepare a PR which modifies |
@bastistician yes, that would be great! |
Oops, I now see that @jayhesselberth has also worked on a solution for this issue (#871), where the maintainer's e-mail address is used as a fallback link. As mentioned above, I would prefer if pkgdown took the more defensive approach of only including a link in the sidebar if and only if there actually is a BugReports field in the DESCRIPTION (#872). That also avoids spreading plain-text e-mail addresses on websites. |
Yours is the simpler solution and I think preferable. Closing #871 for now. |
If the package does not contain a
BugReports
field in its DESCRIPTION file, the generated home page will currently containamong the links generated from
data_home_sidebar_links()
atpkgdown/R/build-home-index.R
Line 82 in 36bedb2
A solution could be to mimic what R's
bug.report()
does since R 2.11.0, i.e., fall back on the maintainer's e-mail address ifBugReports
is unspecified:Alternatively, not including such a link at all would actually best reflect the package DESCRIPTION and possibly the authors intention, so I would favour this more defensive solution. Note that it is always possible for the package authors to manually add intended bug report links to the homepage via the pkgdown configuration file.
The text was updated successfully, but these errors were encountered: