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

Copy edit & link to cheatsheet codelab #1625

Merged
merged 6 commits into from
May 30, 2019
Merged

Copy edit & link to cheatsheet codelab #1625

merged 6 commits into from
May 30, 2019

Conversation

kwalrath
Copy link
Contributor

The `.no_toc` class should make the heading show up in the body but not the TOC. It wasn't showing up either place. Should fix the body style...
@googlebot googlebot added the cla: yes Contributor has signed the Contributor License Agreement label May 18, 2019
@kwalrath kwalrath requested a review from RedBrogdon May 18, 2019 04:51
@kwalrath
Copy link
Contributor Author

@RedBrogdon it occurred to me that we should include the actual cheatsheet in this codelab — or link to another page that's just the cheatsheet. What do you think?

@kwalrath
Copy link
Contributor Author

It also occurred to me that we should be clearer up front about the audience. If it includes beginning Dart developers, then we should offer more help with the API. (Maybe we should do that even if we explicitly don't want Dart learners.)

Copy link
Collaborator

@RedBrogdon RedBrogdon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One tiny nit, which you're free to ignore.

Thanks again for doing this. Now that I'm done traveling for a while, you shouldn't have to wait this long for an LGTM.


Some examples:
Here are some examples of using string interpolation:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "example usages" of string interpolation?

@RedBrogdon
Copy link
Collaborator

@RedBrogdon it occurred to me that we should include the actual cheatsheet in this codelab — or link to another page that's just the cheatsheet. What do you think?

Good idea. My vote would probably be for a separate page, since the "I want to quickly scan and remind myself of the list of features" and "I want to actively practice those features" audiences would likely be pretty distinct.

@kwalrath
Copy link
Contributor Author

@RedBrogdon it occurred to me that we should include the actual cheatsheet in this codelab — or link to another page that's just the cheatsheet. What do you think?

Good idea. My vote would probably be for a separate page, since the "I want to quickly scan and remind myself of the list of features" and "I want to actively practice those features" audiences would likely be pretty distinct.

OK, I'm going to update this PR with that page, so that the name makes sense.

@kwalrath
Copy link
Contributor Author

I've uploaded the cheatsheet page but haven't put it in the sidenav, for a couple of reasons:

  • I'm not crazy about how I formatted it. I'd like it to be visible in a single page, but that'd take a while to make happen.
  • There's not a one-to-one correspondence between items covered in the cheatsheet and the items covered in the codelab. I'd like to make them agree more.

I've updated the staging server:

https://kw-www-dartlang-1.firebaseapp.com/codelabs
https://kw-www-dartlang-1.firebaseapp.com/codelabs/dart-cheatsheet
https://kw-www-dartlang-1.firebaseapp.com/guides/language/cheatsheet

/cc @mehmetf

@kwalrath kwalrath requested a review from RedBrogdon May 30, 2019 15:35
Copy link
Collaborator

@RedBrogdon RedBrogdon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I added a couple minor suggestions, but that's about all I have to offer here. I imagine you'll think of other things to add down the line.

I definitely deviated from the original cheatsheet a few times when I thought I had an idea for a codelab exercise that was within the spirit of the doc and would be a good test for DartPad. I wouldn't worry about being faithful to the codelab contents, therefore, unless you really want to.


Creates a compile-time constant list.

### `= { }`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be good to mention sets in here as well.

```

Use `on` to catch a type.
Use `catch` to catch an instance.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mention that on and catch can be used together?

@kwalrath
Copy link
Contributor Author

I'm going to merge this and put your suggestions for the cheatsheet in a new issue. Thanks for the content and the reviews!

@kwalrath kwalrath merged commit a959abb into master May 30, 2019
@kwalrath kwalrath deleted the kw-cheatsheet branch May 30, 2019 22:12
@kwalrath kwalrath mentioned this pull request Jun 7, 2019
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Contributor has signed the Contributor License Agreement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Link to new codelab
3 participants