Skip to content

Commit

Permalink
Don't use misspellings in the docs
Browse files Browse the repository at this point in the history
The code example(s) should be copy-pastable without errors

#241 #247
  • Loading branch information
bfanger committed Sep 23, 2015
1 parent b0cf646 commit d9d3c31
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/Getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Note that Doctrine annotation supports arrays, but uses the `{` and `}` instead

And although doctrine also supports objects, but also uses `{` and `}` and requires the properties to be surrounded with `"`.

DON'T write:
**DON'T** write:

```php
/**
Expand All @@ -48,15 +48,15 @@ But use the annotation with the same name as the property, such as `@SWG\Info` f
/**
* @SWG\Swagger(
* @SWG\Info(
* titel="My first swagger documented API",
* title="My first swagger documented API",
* version="1.0.0"
* )
* )
*/
```

This adds validation, so when you misspell a property or forget a required property it will trigger a php warning.
For example the snippet above would generate a notice with "Unexpected field "titel" for @SWG\Info(), expecting "title", ..."
For example if you'd write `titel="My first ...` swagger-php whould generate a notice with "Unexpected field "titel" for @SWG\Info(), expecting "title", ..."

## Using variables in annotations

Expand Down

0 comments on commit d9d3c31

Please sign in to comment.