Update doc-format and boot.janet docstrings.

Make doc-format respect leading indents, increase the default format
width to better accommodate markdown formatted documentation. We still
need to support single line style doc strings, such as those used
for most c functions which can be a single line of much longer than
80 or 120 characters.

Consecutive whitespace internal to lines is not preserved, though.
This commit is contained in:
Calvin Rose 2020-11-26 14:58:36 -06:00
parent 7fd2da1096
commit adc3066dc8
3 changed files with 324 additions and 283 deletions

View File

@ -28,10 +28,10 @@ if not "%JANET_BUILD%" == "" (
@set JANET_COMPILE=%JANET_COMPILE% /DJANET_BUILD="\"%JANET_BUILD%\"" @set JANET_COMPILE=%JANET_COMPILE% /DJANET_BUILD="\"%JANET_BUILD%\""
) )
mkdir build if not exist build mkdir build
mkdir build\core if not exist build\core mkdir build\core
mkdir build\mainclient if not exist build\mainclient mkdir build\mainclient
mkdir build\boot if not exist build\boot mkdir build\boot
@rem Build the bootstrap interpreter @rem Build the bootstrap interpreter
for %%f in (src\core\*.c) do ( for %%f in (src\core\*.c) do (

File diff suppressed because it is too large Load Diff

View File

@ -621,7 +621,7 @@ static const JanetReg net_cfuns[] = {
"net/listen", cfun_net_listen, "net/listen", cfun_net_listen,
JDOC("(net/listen host port &opt type)\n\n" JDOC("(net/listen host port &opt type)\n\n"
"Creates a server. Returns a new stream that is neither readable nor " "Creates a server. Returns a new stream that is neither readable nor "
"writeable. Use net/accept or net/accept-loop be to handle connections and start the server." "writeable. Use net/accept or net/accept-loop be to handle connections and start the server. "
"The type parameter specifies the type of network connection, either " "The type parameter specifies the type of network connection, either "
"a :stream (usually tcp), or :datagram (usually udp). If not specified, the default is " "a :stream (usually tcp), or :datagram (usually udp). If not specified, the default is "
":stream. The host and port arguments are the same as in net/address.") ":stream. The host and port arguments are the same as in net/address.")
@ -681,7 +681,7 @@ static const JanetReg net_cfuns[] = {
}, },
{ {
"net/connect", cfun_net_connect, "net/connect", cfun_net_connect,
JDOC("(net/connect host porti &opt type)\n\n" JDOC("(net/connect host port &opt type)\n\n"
"Open a connection to communicate with a server. Returns a duplex stream " "Open a connection to communicate with a server. Returns a duplex stream "
"that can be used to communicate with the server. Type is an optional keyword " "that can be used to communicate with the server. Type is an optional keyword "
"to specify a connection type, either :stream or :datagram. The default is :stream. ") "to specify a connection type, either :stream or :datagram. The default is :stream. ")