Ferreteria/v0.5/@cls: Difference between revisions

Revision as of 19:13, 29 June 2022

Ferreteria v0.5 classes

«ferret» namespace

This is the class documentation paradigm I'm currently trying.

Titles for pages about classlike types (classes, traits, interfaces) should use the minimum unambiguous name. i.e. only include namespace if there's another classlike with the same name in another namespace.
The {{l/ver/class|<class name>}} template can be used to point to the documentation page for a classlike type.
If a classlike page title could refer to more than one class, there will be a disambiguation page.

@@ Line 1: / Line 1: @@
 {{fmt/title|Ferreteria v0.5 classes|{{fmt/code|ferret}} namespace}}
 ==Classes==
-* [[/app]] classes
+* {{l/ver/class|caApp}} application class family
 ==Sub-Namespaces==
 * [[/login]]
@@ Line 8: / Line 8: @@
 ==Meta: Paradigm==
 This is the class documentation paradigm I'm currently trying.
-* Titles for class pages (which includes traits) should not include the [[Conventions/coding#Type Prefixes|prefix]] (c, ca, cs, t, ta, ts).
+* Titles for pages about classlike types (classes, traits, interfaces) should use the minimum unambiguous name. i.e. only include namespace if there's another classlike with the same name in another namespace.
-* The <nowiki>{{</nowiki>{{lt|l/ver/class}}|{{arg|class name}}}} template can be used to point to a class name -- either with prefix and no namespace, or with a namespace and no prefix.
+* The <nowiki>{{</nowiki>{{lt|l/ver/class}}|{{arg|class name}}}} template can be used to point to the documentation page for a classlike type.
-* If not namespaced, the target page should redirect to the correct namespace. If there are multiple classes by that name (in different namespaces), it should list them with links. Ideally, the editor using the template would then correct it to point to the right one.
+* If a classlike page title could refer to more than one class, there will be a disambiguation page.