insightsengineering / insightsengineering/chevron

[docs] some examples does not print the output

Open
#847 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
R
Stars
19
Forks
1
Avg merge
1d 1h
Merged PRs (30d)
1

Description

There are a few articles that does not print the outputs. It's because their example code is just `res <- foo(...)` without printing the `res` (or avoiding assignment completely). Please grep the example code against this pattern. Few examples:
https://insightsengineering.github.io/chevron/main/reference/ael02.html#ref-examples
https://insightsengineering.github.io/chevron/main/reference/ael03.html#ref-examples

Contributor guide

Open the contributing guide

Research direction

Start with the reference examples linked in the issue, especially ael02 and ael03, then grep the example code for assignments such as `res <- foo(...)`. Update affected examples so their output is printed or the assignment is avoided, and confirm the rendered articles show the example results.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.