Wikifunctions:Naming conventions/pl

From Wikifunctions
This page is a translated version of the page Wikifunctions:Naming conventions and the translation is 17% complete.
Other languages:

The page aims to sum up some conventions related to how are objects named at Wikifunctions. Since it's still a young project, there are not many guidelines defined yet.


Labels of objects should be written as if they were an ordinary phrase. Use of Title Case is discouraged (eg. Calculate A Distance Between Earth And Sun On a Given Date). Instead, type something like calculate a distance between Earth and Sun on a given date. Capitalize only proper nouns and other words as required by the desired language grammar rules (eg. nouns in German or weekday names in English) or conventions (in English use RSA and not rsa).

By convention, names of objects that describe data types, should have their first letter capitalized (eg. Object (Z1) or Function (Z8)).

Implementation names

When creating an implementation, please mention the language you used in its name (Python/JavaScript/Composition). If there are more than one implementation in the same language, it's recommended to place an algorithm name in the label as well (provided that the algorithm has its own name).

Przypadki testowe

Label of a test case should provide some clue on what are you checking there. It doesn't have to include value of every input, but should at least specify a domain that you're checking. For instance, you might want to say that this test checks behavior of a string function when it's given letters from Cyrillic alphabet or a methematical function when there's a fraction or complex number passed.

If the test case is related to a string function and you include a string argument value in the test case name, please surround the argument value in qoutes or mark it in an other way so it will be clear what the value is. It's especially helpful if the value contains significant whitespace at the beginning or end (eg. when testing a text trimming function).

Etykiety wielojęzykowe

Labels in multiple languages (using the mul language code) can be used to specify the label in a way that doesn't involve words, for example as a mathematical expression. See true negated is false (Z10512) for an example. At the moment of writing, the software doesn't use these labels as a fallback though.