Expand features to include callouts, headings, lists, and more (per #1) #4

elipousson · 2023-12-08T04:03:42Z

Per #1 this PR includes the following new functions:

qto_block() and qto_div()
qto_span()
qto_dl(), qto_li(), and qto_ol()
qto_heading() and qto_hr()
qto_fig()
qto_shortcode() (and related functions)

These functions are supported by a variety of helper functions that should make it easier to continue building out the features of this package.

Supported by `qto_attributes` helper function and new utilities in utilities.R and utilities-list.R

`qto_heading()` is required for `qto_callout()`

Also `qto_video()` and `qto_pagebreak()` and `qto_kbd()` Also adds `check_src()` (used by `qto_video()`)

Also build README

Adds allow_null parameter to combine helper function (and related embrace + bracket + parentheses functions)

Also - drop sep parameter from qto_div (it didn't do anything) - expose sep parameter for qto_block

Also rename qto_definition_list to qto_dl

Must include a new line before list Also expose sep parameter to switch between tight + wide list spacing + add example showing option for nested lists + expose symbol parameter for qto_ol

ElianHugh · 2023-12-11T03:03:11Z

Thank you for the PR, this looks great! I've had a short pass over the build with a few comments, but happy to have a discussion on anything.

Before committing I'd like to do a final pass to drop some old functions, fix some lintr issues, and fix some RCMD check issues

Edit: whoops. I forgot to actually hit the submit review button :)

R/block.R

R/basics.R

R/map.R

R/figures.R

R/attributes.R

Also fix handling of percent attributes

Also tweak build_readme_qmd to better handle default path

Also expose sep and collapse arguments for qto_block

Fix links in `qto_ol()` + `qto_li()` docs

elipousson · 2023-12-13T01:54:09Z

I think I resolved all of the issues you flagged in your review and filled in a lot of missing documentation so cleaning up the check messages should be a good bit faster. I left the feedback on qto_hr() and map_qto() unresolved just in case there you wanted further changes to the former or to open an issue for the latter before we call it done.

Hopefully, I didn't introduce any new issues with the documentation clean-up! The only item I haven't done is add more tests but I figured you may either have suggestions on how you want that done or you may want to add them yourself as part of that "final pass".

One suggestion for mdapply(): I wonder if reworking it as a pmap_qto() function might be a good approach – should work much the same and provide a parallel to map_qto().

- Add standalones to lintr ignore - Use explicit integers - Match lintr indentation - Implicit return

- Fix description typo of class and id using the opposite identifier

ElianHugh · 2023-12-14T04:02:05Z

Hi Eli, thanks again for submitting the PR. I've just pushed some minor changes for style/linter appeasement, and fixed a few typos. I've also marked mdapply and as_markdown as internal, and will shortly follow up with another PR implementing:

pmap_qto
removal of div, span, mdapply, and as_markdown functions
change the with_* functions to use qto_div instead of the superceded div function

If you're happy with how things are with the PR, I'll go ahead and squash merge it!

elipousson · 2023-12-14T06:39:18Z

Looks good to me. Thanks!

elipousson added 30 commits December 2, 2023 21:58

Add standalone type checks from rlang

668006d

Add qto_block and qto_div

45825dc

Supported by `qto_attributes` helper function and new utilities in utilities.R and utilities-list.R

Add qto_callout()

134af7a

Add qto_heading() and qto_hr()

7bfb17a

`qto_heading()` is required for `qto_callout()`

Add qto_shortcode() function

5c92d27

Also `qto_video()` and `qto_pagebreak()` and `qto_kbd()` Also adds `check_src()` (used by `qto_video()`)

Add docs for qto_shortcode()

17006e9

Add qto_definition_list()

5ab2702

Add qto_fig() and qto_fig_span() helper

cb60adf

Update DESCRIPTION + NAMESPACE

fa64b47

Style package w/ NumSpacesForTab: 2 in .Rproj

81cd1e0

Add build_readme_qmd() + add quarto to Suggests

8a35a0a

Also build README

Add Eli Pousson to authors in DESCRIPTION

37bc5f0

Add tests for qto_block() + qto_div()

eeaa583

Correct example for qto_img()

55f033a

Add input check to combine() helper function

563f067

Add snapshot tests

b85a87f

Add map_qto() function

7caa294

Fix issue w/ qto_definition_list + add .sep parameter

05e1029

Mark div + span functions as internal

2397393

Drop prefixing for rlang functions

f6fa2fe

Update README

3d39756

Fix issue w/ length 1 lists for qto_definition_list

4eb07bc

Fix qto_fig() when caption is missing

60f2fae

Adds allow_null parameter to combine helper function (and related embrace + bracket + parentheses functions)

Return empty embrace "{}" by default

e9dcb9e

Fix bug w/ numeric fence values

6515c3c

Also - drop sep parameter from qto_div (it didn't do anything) - expose sep parameter for qto_block

Add ordered (qto_ol) + unordered lists (qto_li)

3716745

Also rename qto_definition_list to qto_dl

Update docs for qto_div

b917f1d

Add qto_span

7a835c1

Drop sep parameter from qto_callout

fc8298d

Update qto_fig_span to drop empty attribute embrace

86ebe4d

elipousson added 6 commits December 7, 2023 22:50

Update snapshot tests

56f70d3

Update README

08c760d

Remove heading parameter from qto_callout

0d3a31b

Add span + list tests

304bd17

Fix list functions

044aa02

Must include a new line before list Also expose sep parameter to switch between tight + wide list spacing + add example showing option for nested lists + expose symbol parameter for qto_ol

Restore removed fence parameter

43b2b31

ElianHugh self-requested a review December 11, 2023 02:32

ElianHugh reviewed Dec 12, 2023

View reviewed changes

R/block.R Show resolved Hide resolved

R/block.R Outdated Show resolved Hide resolved

R/basics.R Show resolved Hide resolved

R/map.R Show resolved Hide resolved

R/figures.R Outdated Show resolved Hide resolved

R/attributes.R Outdated Show resolved Hide resolved

elipousson added 12 commits December 12, 2023 18:57

Remove fence parameter from qto_div()

6bbaea1

Add check for rule input

ef0f5bb

Fix handling of reference prefix

9d1b635

Allow unnamed attributes

a7958ca

Also fix handling of percent attributes

Clean up examples for qto_block + qto_div

50ec5be

Remove fence arg from qto_callout()

9a96cc9

Add docs for combine

e4e1fd1

Also tweak build_readme_qmd to better handle default path

Add docs for combine

b092c38

Fill in missing attribute definitions

5716c8d

Allow formula inputs for .f

f8e0819

Also expose sep and collapse arguments for qto_block

Fill in missing parameter definitions

c9bd068

Add examples for qto_dl()

1f5ae68

Fix links in `qto_ol()` + `qto_li()` docs

ElianHugh added 3 commits December 14, 2023 09:59

Linter pass

7c9d2ef

- Add standalones to lintr ignore - Use explicit integers - Match lintr indentation - Implicit return

Mark mdapply and as_markdown as internal

a3cd134

Fix attr typo

f0ffd92

- Fix description typo of class and id using the opposite identifier

Update docs

a54cb06

ElianHugh merged commit c102a7b into ElianHugh:main Dec 14, 2023
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expand features to include callouts, headings, lists, and more (per #1) #4

Expand features to include callouts, headings, lists, and more (per #1) #4

elipousson commented Dec 8, 2023

ElianHugh commented Dec 11, 2023 •

edited

Loading

elipousson commented Dec 13, 2023

ElianHugh commented Dec 14, 2023

elipousson commented Dec 14, 2023

Expand features to include callouts, headings, lists, and more (per #1) #4

Expand features to include callouts, headings, lists, and more (per #1) #4

Conversation

elipousson commented Dec 8, 2023

ElianHugh commented Dec 11, 2023 • edited Loading

elipousson commented Dec 13, 2023

ElianHugh commented Dec 14, 2023

elipousson commented Dec 14, 2023

ElianHugh commented Dec 11, 2023 •

edited

Loading