Skip to content

Use fct() to enable auto-linking on pkgdown#119

Merged
nikosbosse merged 2 commits intomasterfrom
review-vignette
Aug 9, 2021
Merged

Use fct() to enable auto-linking on pkgdown#119
nikosbosse merged 2 commits intomasterfrom
review-vignette

Conversation

@Bisaloo
Copy link
Copy Markdown
Contributor

@Bisaloo Bisaloo commented Jul 26, 2021

No description provided.

@codecov
Copy link
Copy Markdown

codecov bot commented Jul 26, 2021

Codecov Report

Merging #119 (bb66c85) into master (de45fb7) will not change coverage.
The diff coverage is n/a.

❗ Current head bb66c85 differs from pull request most recent head 3679d69. Consider uploading reports for the commit 3679d69 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master     #119   +/-   ##
=======================================
  Coverage   48.85%   48.85%           
=======================================
  Files          18       18           
  Lines        1357     1357           
=======================================
  Hits          663      663           
  Misses        694      694           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update de45fb7...3679d69. Read the comment docs.

@Bisaloo Bisaloo mentioned this pull request Jul 27, 2021
53 tasks
@Bisaloo Bisaloo marked this pull request as ready for review July 27, 2021 14:26
Copy link
Copy Markdown
Contributor

@seabbs seabbs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice LGTM

@nikosbosse
Copy link
Copy Markdown
Collaborator

👍 Thanks
Just to make sure I understand this correctly: adding the brackets means the functions will be automatically linked in the pkgdown site? And so ideally, whenever I come across something like this I just add brackets?

@nikosbosse nikosbosse merged commit 4f2b231 into master Aug 9, 2021
@nikosbosse nikosbosse deleted the review-vignette branch August 9, 2021 09:14
@Bisaloo
Copy link
Copy Markdown
Contributor Author

Bisaloo commented Aug 9, 2021

Yes, this happens thanks to the downlit package.

This is also somewhat similar the behaviour of roxygen2. [foo()] links the the function foo() while [foo] links to a topic.

It's probably a good habit to use this syntax anyways as it helps the reader to make the difference between functions and other objects.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants