From 3c7ad1994ed0e41dfccfdc19789ceb2839f938b6 Mon Sep 17 00:00:00 2001 From: jdsteve2 Date: Tue, 26 May 2020 11:34:11 -0500 Subject: [PATCH] move var name registryinto ref_kernel --- doc/ref_kernel.rst | 26 ++++++++++++++++++++++++++ doc/ref_naming.rst | 28 ---------------------------- 2 files changed, 26 insertions(+), 28 deletions(-) delete mode 100644 doc/ref_naming.rst diff --git a/doc/ref_kernel.rst b/doc/ref_kernel.rst index 409cbef57..89f96d01f 100644 --- a/doc/ref_kernel.rst +++ b/doc/ref_kernel.rst @@ -151,6 +151,32 @@ Tag Meaning .. }}} +Variable Name Registry +---------------------- + +Reserved Kernel Variable Names +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The variable name prefix ``_lp`` is reserved for internal usage; when creating +kernel variables, users should *not* use names beginning with ``_lp``. This +prefix is used for certain variables created when operating on Loopy's kernel +IR. For Loopy developers, further information on name prefixes used within +submodules is below. + +Some Loopy submodules append a sub-prefix to the ``_lp`` prefix for +internally-created variable names. These prefixes should only be used for names +created within the listed submodule. + +Reserved Name Prefixes +^^^^^^^^^^^^^^^^^^^^^^ + +=============== ================================== +Prefix Module +=============== ================================== +``_lp`` :mod:`loopy` +``_lp_sched`` :mod:`loopy.linearization.checker` +=============== ================================== + .. _instructions: Instructions diff --git a/doc/ref_naming.rst b/doc/ref_naming.rst deleted file mode 100644 index ffb640730..000000000 --- a/doc/ref_naming.rst +++ /dev/null @@ -1,28 +0,0 @@ -Reference: Variable Name Registry -================================= - -Reserved Kernel Variable Names ------------------------------- - -The variable name prefix ``_lp`` is reserved for internal usage; when creating -kernel variables, users should *not* use names beginning with ``_lp``. This -prefix is used for certain variables created when operating on Loopy's kernel -IR. For Loopy developers, further information on name prefixes used within -submodules is below. - -Variable Name Registry ----------------------- - -Some Loopy submodules append a sub-prefix to the ``_lp`` prefix for -internally-created variable names. These prefixes should only be used for names -created within the listed submodule. - -Reserved Name Prefixes -^^^^^^^^^^^^^^^^^^^^^^ - -=============== ================================== -Prefix Module -=============== ================================== -``_lp`` :mod:`loopy` -``_lp_sched`` :mod:`loopy.linearization.checker` -=============== ================================== -- GitLab