Skip to content

Octane guides review: ensure code examples are complete #583

Closed
@mike-north

Description

@mike-north

The octane guides (#455) are coming along really well!

One thing that we could use some help with is reviewing all markdown "fenced code blocks"

```javascript

```
```handlebars

```

are...

  1. Valid language syntax.

    A good way of checking this is to open up https://babeljs.io/repl and paste a code sample in the left editor pane.

  2. Complete

    Some of them seem to be missing imports, particularly for decorators like @tracked, @action, etc... The good news is, other examples are complete, and will provide an indication of where to import from.

    If examples use something like "..." to provide an excerpt, please make sure it's in a comment, so that if readers copy/paste code into their editor, it's only incomplete and not broken.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions