summaryrefslogtreecommitdiff
path: root/CODING_STANDARDS
diff options
context:
space:
mode:
authorRon Chmara <ronabop@php.net>2000-10-18 07:34:56 (GMT)
committerRon Chmara <ronabop@php.net>2000-10-18 07:34:56 (GMT)
commitd47e48329b80e8e4721a9ee62b184378185ba7db (patch)
tree2502df3c9183396c021b65886d4cf03a7d6f9fe0 /CODING_STANDARDS
parent2ecce2dc35672badc2bf3b5ccf311b8b3e50bc6a (diff)
downloadphp-d47e48329b80e8e4721a9ee62b184378185ba7db.tar.gz
As per andi, similar names are for legacy reasons only.
Diffstat (limited to 'CODING_STANDARDS')
-rw-r--r--CODING_STANDARDS20
1 files changed, 7 insertions, 13 deletions
diff --git a/CODING_STANDARDS b/CODING_STANDARDS
index e53ee4f..5e4a7b7 100644
--- a/CODING_STANDARDS
+++ b/CODING_STANDARDS
@@ -162,23 +162,17 @@ Optional arguments are written like this:
And yes, please keep everything on a single line, even if that line is massive.
-User Aliases
---------------------
-You may also have some user-level aliases with close to duplicate
+Aliases & Legacy Documentation
+-----------------------------------
+You may also have some deprecated aliases with close to duplicate
names, for example, somedb_select_result and somedb_selectresult. For
documentation puposes, these will only be documented by the most
-clearly separated name, with the aliases listed in the documentation for
+current name, with the aliases listed in the documentation for
the parent function. For ease of reference, user-functions with
completely different names, that alias to the same function (such as
highlight_file and show_source), will be separately documented. The
proto should still be included, describing which function is aliased.
-
-Legacy Documentation
---------------------
-In order to retire older function naming conventions, older
-function name variants, when changed, will only be documented under
-their current function name, as aliases. Backwards compatible functions
-and names should be maintained as long as the code can be reasonably
-be kept as part of the codebase. See /phpdoc/README for me information
-on documentation.
+Backwards compatible functions and names should be maintained as long
+as the code can be reasonably be kept as part of the codebase. See
+/phpdoc/README for me information on documentation.