Skip to content

Migration may be skipped if DESCRIPTION has both pre-8.0.0 and 8.0.0 RoxygenNote entries #1876

@gadenbuie

Description

@gadenbuie

When working on a package where a collaborator has already upgraded to roxygen2 8.0.0, it’s possible to end up with both the old and new RoxygenNote entries in DESCRIPTION.

In my case, I still had roxygen2 7.3.3 installed but a collaborator had already upgraded the package documentation to use v8.0.0. Regenerating docs created a bunch of diff noise and added RoxygenNote: 7.3.3 to DESCRIPTION.

I then installed roxygen2 8.0.0 and rebuilt the docs. That removed the documentation diffs, but left the newly added RoxygenNote: 7.3.3 line. Because the file also already had the 8.0.0-era RoxygenNote entry from my collaborator, I think the migration step may have been skipped.

This seems likely to happen in collaborative workflows where one person has already upgraded to roxygen2 8.0.0 and another person regenerates docs before upgrading.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions