convert_helpers: Conversion Helpers

In roxytypes: Typed Parameter Tags for Integration with 'roxygen2'

Conversion Helpers

Description

Various functions for supporting conversion from standard roxygen tags to ⁠@typed⁠ tags.

Usage

convert_continue_prompt()

preview_convert_edits(edits, n = 1)

preview_convert_edit(edit)

format_diff_chr(d, offset)

diff_lines(d)

Arguments

n	(integer[1]) A number of edits to display.
edit, edits	(data.frame) As produced by convert_edit_df. Contains the edit source file, starting line number, number of original lines modified, the new content to insert and whether the format was matched for the edit. When singular, the data.frame is a single row.
d	(cli::diff_chr() result) The diff of the original and new tag contents.
offset	(integer[1]) A line offset for the start of the diff.

Value

NULL

Functions

• convert_continue_prompt(): Show a dialog to ask the user how they would like to proceed

• preview_convert_edits(): Preview diffs after applying conversion rules

• preview_convert_edit(): Preview diffs after applying conversion rules

• format_diff_chr(): Format a diff object for cli display

• diff_lines(): Build a data.frame of old and new line numbers for a diff

roxytypes documentation built on Oct. 16, 2024, 1:06 a.m.