Skip to content

Commit

Permalink
doc(readme): add 'Limitation' section (swaggo#43)
Browse files Browse the repository at this point in the history
* doc(readme): add limitation section

* doc(readme): update link

* doc(readme): update link
  • Loading branch information
easonlin404 authored Feb 19, 2018
1 parent 85af9b7 commit b1a69cd
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,10 @@ type Pet3 struct {
- [gin-swagger](http://github.com/swaggo/gin-swagger)
- [echo-swagger](http://github.com/swaggo/echo-swagger)

## Limitation
- Not supported for array of structs
- Not supported for cross-package models. Only search in project root folder. [See #39](https://github.com/swaggo/swag/issues/39)

## TODO
- [ ] supplement better documentation
- [ ] add more example
Expand Down

0 comments on commit b1a69cd

Please sign in to comment.