Add usage example to APIDoc and updated README #51
Conversation
helenmasters
commented
Jul 11, 2018
helenmasters
commented
- Added usage example to APIDoc for Session and CookieParameters
- Added further descriptions to parameters in APIDoc
- Fixed typos in APIDoc
- Added APIDoc link to the README header
- Added missing standard sections to README
- Reworded parts of the README
helenmasters
added
the
jazzy-doc
README.md
Outdated
| import KituraSession | ||
| import KituraSessionRedis | ||
|
|
||
| let redisStore = RedisStore(redisHost: host, redisPort: port) | ||
| let session = Session(secret: "Some secret", store: redisStore) | ||
| router.all(middleware: session) | ||
| ``` | ||
| First an instance of `RedisStore` is created (see [`KituraSessionRedis`](https://github.com/IBM-Swift/Kitura-Session-Redis) for more information), then an instance of `Session` with the store as parameter is created, and finally it is connected to the desired path. | ||
| First an instance of `RedisStore` is created (see [`KituraSessionRedis`](https://github.com/IBM-Swift/Kitura-Session-Redis) for more information), then an instance of `Session` with the store as a parameter is created, then it is connected to the desired path. |
There was a problem hiding this comment.
I'd prefer
An instance of
RedisStoreis created that will be used to persist session data (seeKituraSessionRedisfor more information). An instance ofSessionis then created, specifying redisStore as the session store. Finally, the session instance is registered as a middleware on the desired path.
| case name(String) | ||
|
|
||
| /// The cookie's Path attribute. | ||
| /// The cookie's path attribute, this defines the path for which this cookie should be supplied. |
There was a problem hiding this comment.
The cookie's path attribute. This specifies the path for which the cookie is valid. The client should only provide this cookie for requests on this path.
| public enum CookieParameter { | ||
|
|
||
| /// The cookie's name. | ||
| /// The cookie's name, defaults to "kitura-session-id". |
There was a problem hiding this comment.
name, defaults to -> name. Defaults to
| case path(String) | ||
|
|
||
| /// The cookie's Secure attribute. | ||
| /// The cookie's secure attribute, this indicates whether the cookie should be provided only |
There was a problem hiding this comment.
attribute, this indicates whether -> attribute, indicating whether
* Added usage example to APIDoc for Session and CookieParameters * Added further descriptions to parameters in APIDoc * Fixed typos in APIDoc * Added APIDoc link to the README header * Added missing standard sections to README * Reworded parts of the README
Andrew-Lees11
force-pushed
the
standardizeREADME
branch
from
511d767 to
85c9ee7
Compare
|
I have addressed mine and @djones6 review comments and rebased this PR on top of the current master. |
