-
Notifications
You must be signed in to change notification settings - Fork 138
Combining syntax cheat sheet and full syntax reference pages #2426
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
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2426 +/- ##
=======================================
Coverage 48.92% 48.92%
=======================================
Files 124 124
Lines 5245 5245
Branches 1110 1110
=======================================
Hits 2566 2566
Misses 2371 2371
Partials 308 308 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
page is looking great! here are a couple of things to check on
|
||
{% from "userGuide/fullSyntaxReference.md" import syntax_topics as topics %} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes sorry for my mistake, I've since updated the code!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On an unrelated note, I think this page can benefit from a site nav, maybe I can open an issue to quickly add it in?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, new issue and minor change sounds good. While you're at it, I think a tip box at the top (similar to the syntax reference page) wouldn't hurt
|
||
<include src="codeAndOutput.md" boilerplate > | ||
<include src="codeAndOutput.md" boilerplate > |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
unrelated formatting change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! thanks for reworking this, I think it will be nice from a user perspective ❤️
What is the purpose of this pull request?
Overview of changes:
Implements the changes as discussed in issue #2091, more specifically I'm implementing the points as summarised here by @kaixin-hc
Anything you'd like to highlight/discuss:
Open to any discussion regarding how best to structure/implement the syntax reference page.
Testing instructions:
Load the UG and ensure changes are according to what is discussed.
Proposed commit message: (wrap lines at 72 characters)
Combine syntax cheat sheet and full syntax reference pages
Checklist: ☑️