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

Rewrite manual/variables.md #2798

Merged
merged 10 commits into from
Nov 14, 2021
Merged

Rewrite manual/variables.md #2798

merged 10 commits into from
Nov 14, 2021

Conversation

odow
Copy link
Member

@odow odow commented Nov 11, 2021

I think there's a lot of improvements that could be made to the Variables page in the manual:

  • The introduction is confusing, and front-loads a lot of terminology
  • We take too long to get to different parts. We should start by example, then go into detail
  • The organization could be improved. More level-2 headers should be "How to" type queries so they are easier to navigate. Currently, we have "Variable names" as a ##, and things like "How to query a variable by name" are buried unless you read the entire docs.

@codecov
Copy link

codecov bot commented Nov 11, 2021

Codecov Report

Merging #2798 (bc14945) into master (744888c) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2798   +/-   ##
=======================================
  Coverage   94.26%   94.26%           
=======================================
  Files          43       43           
  Lines        5524     5525    +1     
=======================================
+ Hits         5207     5208    +1     
  Misses        317      317           
Impacted Files Coverage Δ
src/Containers/macro.jl 100.00% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 744888c...bc14945. Read the comment docs.

@odow odow changed the title WIP: rewrite the variables documentation Rewrite manual/variables.md Nov 12, 2021
@odow odow merged commit 9a16b90 into master Nov 14, 2021
@odow odow deleted the od/docs-variables branch November 14, 2021 04:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants