mirror of
https://github.com/nim-lang/Nim.git
synced 2026-01-09 22:43:34 +00:00
documentation style tweaks (#10790)
* exports are the least important field in the docs: they are put in the last place (at the bottom) * indent text after proc/type declaration for an easier navigation (noticeable difference between declarations and examples) * quickfix invalid style in `asynchttpserver`
This commit is contained in:
@@ -20,7 +20,7 @@ import
|
||||
pathutils
|
||||
|
||||
const
|
||||
exportSection = skTemp
|
||||
exportSection = skField
|
||||
|
||||
type
|
||||
TSections = array[TSymKind, Rope]
|
||||
@@ -893,9 +893,9 @@ proc generateTags*(d: PDoc, n: PNode, r: var Rope) =
|
||||
else: discard
|
||||
|
||||
proc genSection(d: PDoc, kind: TSymKind) =
|
||||
const sectionNames: array[skTemp..skTemplate, string] = [
|
||||
"Exports", "Imports", "Types", "Vars", "Lets", "Consts", "Vars", "Procs", "Funcs",
|
||||
"Methods", "Iterators", "Converters", "Macros", "Templates"
|
||||
const sectionNames: array[skModule..skField, string] = [
|
||||
"Imports", "Types", "Vars", "Lets", "Consts", "Vars", "Procs", "Funcs",
|
||||
"Methods", "Iterators", "Converters", "Macros", "Templates", "Exports"
|
||||
]
|
||||
if d.section[kind] == nil: return
|
||||
var title = sectionNames[kind].rope
|
||||
|
||||
@@ -533,11 +533,11 @@ dl {
|
||||
|
||||
dt {
|
||||
margin-bottom: -0.5em;
|
||||
margin-left: 0.5em; }
|
||||
margin-left: 0.0em; }
|
||||
|
||||
dd {
|
||||
margin-left: 0.5em;
|
||||
margin-bottom: 2.5em;
|
||||
margin-left: 2.0em;
|
||||
margin-bottom: 3.0em;
|
||||
margin-top: 0.5em; }
|
||||
|
||||
|
||||
|
||||
@@ -15,8 +15,8 @@
|
||||
## allowing users to connect directly to this server.
|
||||
##
|
||||
##
|
||||
## Examples
|
||||
## --------
|
||||
## Basic usage
|
||||
## -----------
|
||||
##
|
||||
## This example will create an HTTP server on port 8080. The server will
|
||||
## respond to all requests with a ``200 OK`` response code and "Hello World"
|
||||
@@ -85,8 +85,8 @@ proc respond*(req: Request, code: HttpCode, content: string,
|
||||
##
|
||||
## This procedure will **not** close the client socket.
|
||||
##
|
||||
## Examples
|
||||
## --------
|
||||
## Example:
|
||||
##
|
||||
## .. code-block::nim
|
||||
## import json
|
||||
## proc handler(req: Request) {.async.} =
|
||||
|
||||
@@ -345,11 +345,11 @@ dl {
|
||||
|
||||
dt {
|
||||
margin-bottom: -0.5em;
|
||||
margin-left: 0.5em; }
|
||||
margin-left: 0.0em; }
|
||||
|
||||
dd {
|
||||
margin-left: 0.5em;
|
||||
margin-bottom: 2.5em;
|
||||
margin-left: 2.0em;
|
||||
margin-bottom: 3.0em;
|
||||
margin-top: 0.5em; }
|
||||
|
||||
|
||||
|
||||
@@ -345,11 +345,11 @@ dl {
|
||||
|
||||
dt {
|
||||
margin-bottom: -0.5em;
|
||||
margin-left: 0.5em; }
|
||||
margin-left: 0.0em; }
|
||||
|
||||
dd {
|
||||
margin-left: 0.5em;
|
||||
margin-bottom: 2.5em;
|
||||
margin-left: 2.0em;
|
||||
margin-bottom: 3.0em;
|
||||
margin-top: 0.5em; }
|
||||
|
||||
|
||||
|
||||
@@ -345,11 +345,11 @@ dl {
|
||||
|
||||
dt {
|
||||
margin-bottom: -0.5em;
|
||||
margin-left: 0.5em; }
|
||||
margin-left: 0.0em; }
|
||||
|
||||
dd {
|
||||
margin-left: 0.5em;
|
||||
margin-bottom: 2.5em;
|
||||
margin-left: 2.0em;
|
||||
margin-bottom: 3.0em;
|
||||
margin-top: 0.5em; }
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user