From 2c123e082a4fea6fa82132f6ab0f7257daac3f59 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 19 May 2018 21:42:07 -0700 Subject: fixes #458 Improve man page section descriptions. --- docs/man/man3compat.desc | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) (limited to 'docs/man/man3compat.desc') diff --git a/docs/man/man3compat.desc b/docs/man/man3compat.desc index a1141850..a35173c0 100644 --- a/docs/man/man3compat.desc +++ b/docs/man/man3compat.desc @@ -1,3 +1,13 @@ This section documents the _nanomsg_ 1.0 libary compatible functions. -The functions in this section not be used except to aid in transitioning -from the older _libnanomsg_ library. \ No newline at end of file + +These functions are provided as a transition aid, for application +developers coming to _NNG_ from _libnanomsg_, and are discouraged +from use in new applications. + +TIP: While this is discouraged for long term use, as a transition aid +applications may use the value returned by the +<> in these functions just like a +socket descriptor (as if the socket were opened +via <>). +This sort of API intermixing should only be used during transition from +the legacy API to the new API. -- cgit v1.2.3-70-g09d2