Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Slightly improved Readme examples #258

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Slightly improved Readme examples #258

wants to merge 2 commits into from

Conversation

rrmn
Copy link

@rrmn rrmn commented Jan 3, 2019

  • added {closest_state} to title of example 1 -> makes the graphic understandable at first glance and shows this crucial variable in the code
  • added names to code chunks -> graphics don't get saved under unnamed-chunk.gif

@thomasp85
Copy link
Owner

My reason for not adding labels to the first example was to keep it absolutely minimal... labelling is introduced in the next example, so I think that's ok..?

@rrmn
Copy link
Author

rrmn commented Jan 4, 2019

Totally agree with the minimal approach. The issue: the example is not intuitively comprehensible as it stands. Right now it is really, really hard to understand what is going on in the gif. Can you think of an alternative way to clarify it more?

The PR is based on my own learning curve and questions that have popped up from colleagues and on SO. Using labelling was an attempt to kill two birds with one stone (easier comprehension + closest state).

@thomasp85
Copy link
Owner

That makes sense... I'll try to think of a better minimal example...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants