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

Add pitch #128

Merged
merged 15 commits into from
Oct 4, 2021
Merged

Add pitch #128

merged 15 commits into from
Oct 4, 2021

Conversation

maelle
Copy link
Member

@maelle maelle commented Sep 24, 2021

Fix #106
Fix #105
Fix #104
Fix #115
Fix #32
Fix #123
Fix #114
Fix #127

TODOS

README.Rmd Outdated
* If your package...

* is brand-new, remember to run `fledge::bump_version()` regularly.
* has already undergone some development, not too late to jump on the train! Run `fledge::bump_version()` and then `fledge::tag_version()`.
Copy link
Member Author

Choose a reason for hiding this comment

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

mmh actually does one really need fledge::tag_version() at this stage? actually no since it's called by bump_version() via finalize_version()? @krlmlr

Copy link
Contributor

Choose a reason for hiding this comment

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

tag_version() is called by finalize_version() . Can we showcase "jumping on the train" in the demo vignette?

README.Rmd Show resolved Hide resolved
README.Rmd Outdated Show resolved Hide resolved
man/rmd-fragments/caveats.Rmd Outdated Show resolved Hide resolved
man/rmd-fragments/faq.Rmd Outdated Show resolved Hide resolved
@@ -0,0 +1,79 @@
---
title: "Fledge internals"
Copy link
Member Author

Choose a reason for hiding this comment

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

these are not really internals though. I was putting this outside of the main vignette as it might be too detailed? 🤔

Copy link
Contributor

Choose a reason for hiding this comment

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

Most users will only need bump_version() and finalize_version() . Should we account for that in the reference index and in the table?

@maelle maelle requested a review from krlmlr October 1, 2021 13:02
@maelle
Copy link
Member Author

maelle commented Oct 1, 2021

I explored the pkgdown failure 🕵️‍♀️ https://github.com/r-lib/pkgdown/issues/1797 -- but why is the pkgdown workflow using pkgdown dev version?

@krlmlr

This comment has been minimized.

@krlmlr
Copy link
Contributor

krlmlr commented Oct 1, 2021

I enjoy walking the bleeding edge with pkgdown.

@krlmlr
Copy link
Contributor

krlmlr commented Oct 1, 2021

Can you please push to a branch that starts with docs- in the main repo so that we get a preview of the documentation? Use https://github.com/r-lib/downlit/tree/f-readme-document to render the README.

Copy link
Contributor

@krlmlr krlmlr left a comment

Choose a reason for hiding this comment

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

Thanks, looks great overall!

README.Rmd Show resolved Hide resolved
man/rmd-fragments/caveats.Rmd Outdated Show resolved Hide resolved
man/rmd-fragments/faq.Rmd Outdated Show resolved Hide resolved
man/rmd-fragments/faq.Rmd Outdated Show resolved Hide resolved
man/rmd-fragments/faq.Rmd Outdated Show resolved Hide resolved
man/rmd-fragments/summary.Rmd Outdated Show resolved Hide resolved
man/rmd-fragments/summary.Rmd Outdated Show resolved Hide resolved
man/rmd-fragments/usage.Rmd Show resolved Hide resolved
man/rmd-fragments/usage.Rmd Outdated Show resolved Hide resolved
@@ -0,0 +1,79 @@
---
title: "Fledge internals"
Copy link
Contributor

Choose a reason for hiding this comment

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

Most users will only need bump_version() and finalize_version() . Should we account for that in the reference index and in the table?

maelle and others added 4 commits October 4, 2021 14:17
@maelle maelle mentioned this pull request Oct 4, 2021
@maelle
Copy link
Member Author

maelle commented Oct 4, 2021

@krlmlr a few remaining items

Most users will only need bump_version() and finalize_version()

You mean most users won't do CRAN (or Bioconductor etc) releases?

@maelle maelle marked this pull request as ready for review October 4, 2021 12:35
@maelle maelle requested a review from krlmlr October 4, 2021 13:09
Copy link
Contributor

@krlmlr krlmlr left a comment

Choose a reason for hiding this comment

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

Thanks! I'll review the rendered version.

@krlmlr krlmlr merged commit 8cbb3b0 into cynkra:main Oct 4, 2021
@krlmlr
Copy link
Contributor

krlmlr commented Oct 4, 2021

Thanks! (Once I can get it to render, that is.)

@maelle
Copy link
Member Author

maelle commented Oct 4, 2021

@krlmlr except it can't be rendered with pkgdown dev version 😭

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 5, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.