From 18eb54f4170841275e403810f437e29d2dad58f7 Mon Sep 17 00:00:00 2001 From: Aaron Ayres Date: Tue, 17 Nov 2020 12:21:51 -0600 Subject: [PATCH 1/4] very basic first pass of naming documentation --- docs/source/index.rst | 1 + docs/source/naming/Introduction.rst | 6 ++++++ 2 files changed, 7 insertions(+) create mode 100644 docs/source/naming/Introduction.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 22f1ec359..7524bf023 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -9,6 +9,7 @@ AppTools Documentation scripting/* undo/* selection/* + naming/* api * :ref:`search` diff --git a/docs/source/naming/Introduction.rst b/docs/source/naming/Introduction.rst new file mode 100644 index 000000000..f666bf952 --- /dev/null +++ b/docs/source/naming/Introduction.rst @@ -0,0 +1,6 @@ +Naming +====== + +Apptools naming is a python implementation of the naming portion of the `Java +Naming and Directory Interface `_, +including specific implementations for a heirarchy of Python objects. From 348a321bd6931c1de9beb361522ba49fcfead341 Mon Sep 17 00:00:00 2001 From: Aaron Ayres Date: Wed, 18 Nov 2020 09:12:32 -0600 Subject: [PATCH 2/4] add another (similar) useful link --- docs/source/naming/Introduction.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/naming/Introduction.rst b/docs/source/naming/Introduction.rst index f666bf952..d63ac848a 100644 --- a/docs/source/naming/Introduction.rst +++ b/docs/source/naming/Introduction.rst @@ -3,4 +3,5 @@ Naming Apptools naming is a python implementation of the naming portion of the `Java Naming and Directory Interface `_, -including specific implementations for a heirarchy of Python objects. +including specific implementations for a heirarchy of Python objects. You can +also find the Java JNDI tutorial `here `_. From 9b4b9595ed537f3cdb78e6bd7f4129fe62b0872b Mon Sep 17 00:00:00 2001 From: Aaron Ayres Date: Wed, 18 Nov 2020 09:27:39 -0600 Subject: [PATCH 3/4] add a news fragment --- docs/releases/upcoming/221.doc.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/releases/upcoming/221.doc.rst diff --git a/docs/releases/upcoming/221.doc.rst b/docs/releases/upcoming/221.doc.rst new file mode 100644 index 000000000..0ba971c94 --- /dev/null +++ b/docs/releases/upcoming/221.doc.rst @@ -0,0 +1 @@ +Add a brief section to documentation for ``apptools.naming`` (#221) \ No newline at end of file From 6f5a880adfaf0d4f7e5eb67af8ea4cdecfd39624 Mon Sep 17 00:00:00 2001 From: aaronayres35 <36972686+aaronayres35@users.noreply.github.com> Date: Wed, 18 Nov 2020 11:57:21 -0600 Subject: [PATCH 4/4] Apply suggestions from code review Co-authored-by: Kit Choi --- docs/source/naming/Introduction.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/naming/Introduction.rst b/docs/source/naming/Introduction.rst index d63ac848a..736f4b92a 100644 --- a/docs/source/naming/Introduction.rst +++ b/docs/source/naming/Introduction.rst @@ -1,7 +1,7 @@ Naming ====== -Apptools naming is a python implementation of the naming portion of the `Java +:mod:`apptools.naming` package is a Python implementation of the Naming portion of the `Java Naming and Directory Interface `_, including specific implementations for a heirarchy of Python objects. You can also find the Java JNDI tutorial `here `_.