Skip to content

Commit

Permalink
refresh docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shikokuchuo committed Sep 26, 2023
1 parent ab47277 commit 122331f
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 23 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: nanonext
Type: Package
Title: NNG (Nanomsg Next Gen) Lightweight Messaging Library
Version: 0.10.1
Version: 0.10.1.9000
Description: R binding for NNG (Nanomsg Next Gen), a successor to ZeroMQ. NNG is
a socket library providing high-performance scalability protocols, a
cross-platform standard for messaging and communications. Serves as a
Expand Down
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# nanonext 0.10.1.9000 (development)

# nanonext 0.10.1

#### New Features
Expand Down
18 changes: 9 additions & 9 deletions R/docs.R
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

#' Protocols [Documentation]
#'
#' @description Protocols implemented by \{nanonext\}.
#' @description Protocols implemented by \pkg{nanonext}.
#'
#' For an authoritative guide please refer to the online documentation for
#' the NNG library at \url{https://nng.nanomsg.org/man/}.
Expand Down Expand Up @@ -126,7 +126,7 @@ NULL

#' Transports [Documentation]
#'
#' @description Transports supported by \{nanonext\}.
#' @description Transports supported by \pkg{nanonext}.
#'
#' For an authoritative guide please refer to the online documentation for
#' the NNG library at \url{https://nng.nanomsg.org/man/}.
Expand Down Expand Up @@ -154,7 +154,7 @@ NULL
#'
#' @section IPC:
#'
#' The ipc transport provides communication support between sockets
#' The IPC transport provides communication support between sockets
#' within different processes on the same host. For POSIX platforms, this is
#' implemented using UNIX domain sockets. For Windows, this is implemented
#' using Windows Named Pipes. Other platforms may have different
Expand Down Expand Up @@ -200,9 +200,9 @@ NULL
#'
#' @section TCP/IP:
#'
#' The tcp transport provides communication support between sockets
#' across a TCP/IP network. Both IPv4 and IPv6 are supported when the
#' underlying platform also supports it.
#' The TCP transport provides communication support between sockets
#' across a TCP/IP network. Both IPv4 and IPv6 are supported when supported
#' by the underlying platform.
#'
#' [\strong{URI, tcp://}] This transport uses URIs using the scheme tcp://,
#' followed by an IP address or hostname, followed by a colon and finally
Expand Down Expand Up @@ -239,9 +239,9 @@ NULL
#'
#' @section TLS:
#'
#' The tls transport provides communication support between peers across a
#' The TLS transport provides communication support between peers across a
#' TCP/IP network using TLS v1.2 on top of TCP. Both IPv4 and IPv6 are
#' supported when the underlying platform also supports it.
#' supported when supported by the underlying platform.
#'
#' [\strong{URI, tls+tcp://}] This transport uses URIs using the scheme
#' tls+tcp://, followed by an IP address or hostname, followed by a colon
Expand All @@ -260,7 +260,7 @@ NULL
#'
#' The ws and wss transport provides communication support between peers
#' across a TCP/IP network using WebSockets. Both IPv4 and IPv6 are
#' supported when the underlying platform also supports it.
#' supported when supported by the underlying platform.
#'
#' [\strong{URI, ws://}] This transport uses URIs using the scheme ws://,
#' followed by an IP address or hostname, optionally followed by a colon and
Expand Down
3 changes: 1 addition & 2 deletions R/nanonext-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,7 @@
#'
#' @section Links:
#'
#' nanonext website: \url{https://shikokuchuo.net/nanonext/} \cr
#' nanonext on CRAN: \url{https://cran.r-project.org/package=nanonext}
#' \CRANpkg{nanonext} website: \url{https://shikokuchuo.net/nanonext/}
#'
#' NNG website: \url{https://nng.nanomsg.org/} \cr
#' Mbed TLS website: \url{https://www.trustedfirmware.org/projects/mbed-tls/}
Expand Down
3 changes: 1 addition & 2 deletions man/nanonext-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/protocols.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 8 additions & 8 deletions man/transports.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 122331f

Please sign in to comment.