decorate_code_and_alerts: Make lines of code look nice in markdown, with their alerts

Description Usage Arguments Value

View source: R/functions.R

Description

it's called from read_and_decorate_code

Usage

1
2
3
4
5
6
7
8
9
decorate_code_and_alerts(
  strings,
  alerts,
  region_only = FALSE,
  region_size = 3,
  size_line_of_code = 160,
  length_alert_name = 35,
  use_mnemonic = FALSE
)

Arguments

strings

lines of code

alerts

alerts

region_only

include only regions near alerts?

region_size

size of the region near alerts contained in the output

size_line_of_code

size of lines of code in the markdown output

length_alert_name

size of lines of alert names in the markdown output

Value

a string to be used in a markdown file


crotman/kludgenudger documentation built on Oct. 19, 2021, 7:30 p.m.