- Revision
- 11334
- Author
- bkirsch
- Date
- 2006-08-04 17:13:49 -0700 (Fri, 04 Aug 2006)
Log Message
API documentation clarification
Modified Paths
Diff
Modified: trunk/chandler/projects/EggTranslations-Plugin/egg_translations.py (11333 => 11334)
--- trunk/chandler/projects/EggTranslations-Plugin/egg_translations.py 2006-08-04 22:55:20 UTC (rev 11333) +++ trunk/chandler/projects/EggTranslations-Plugin/egg_translations.py 2006-08-05 00:13:49 UTC (rev 11334) @@ -52,7 +52,7 @@ @param message: c{unicode} or {str} message key used to lookup a localization - @type message: c{unicode} or {str} + @type message: c{unicode} or ASCII {str} @param args: An optional argument which if passed will be returned if no localzation @@ -171,7 +171,8 @@ codes. The value(s) must be able to be converted to ASCII. - @type localeSet: c{str} or c{unicode} or c{List} containing + @type localeSet: ASCII c{str} or c{unicode} or + c{List} containing ASCII c{str} or c{unicode} values @param iniFileName: The name of the resource ini file @@ -188,7 +189,7 @@ method. The default encoding is "UTF-8". - @type iniFileName: c{str} or c{unicode} + @type iniFileName: ASCII c{str} or c{unicode} @param encoding: The character set encoding of the iniFileName. This encoding will be @@ -196,7 +197,7 @@ in the iniFileName to c{unicode}. The default encoding is "UTF-8". - @type encoding: c{str} or c{unicode} + @type encoding: ASCII c{str} or c{unicode} @param fallback: Indicates whether locale set fallback should take place. If set to True, the @@ -269,7 +270,7 @@ The project name must be either an ASCII c{str} or c{unicode}. - @type project: c{str} or c{unicode} + @type project: ASCII c{str} or c{unicode} @param name: name is the key to lookup in a resource ini file to retrieve the @@ -279,7 +280,7 @@ The name must be either an ASCII c{str} or c{unicode}. - @type name: c{str} or c{unicode} + @type name: ASCII c{str} or c{unicode} @param locale: Optional argument that if specified @@ -290,7 +291,7 @@ a valid language / country locale i.e. "en_US" or "en" - @type locale: c{unicode} or c{str} + @type locale: c{unicode} or ASCII c{str} @return: c{bool} True if the name is found otherwise False """ @@ -350,6 +351,7 @@ ... "myimage", "fr") /resource/imgs/myimage.png >>> + The getValueForKey method can raise the following exceptions: 1. c{UnicodeDecodeError} 2. c{UnicodeEncodeError} @@ -364,7 +366,7 @@ The project name must be either an ASCII c{str} or c{unicode}. - @type project: c{str} or c{unicode} + @type project: ASCII c{str} or c{unicode} @param name: name is the key to lookup in a resource ini file to retrieve the @@ -374,7 +376,7 @@ The name must be either an ASCII c{str} or c{unicode}. - @type name: c{str} or c{unicode} + @type name: ASCII c{str} or c{unicode} @param locale: Optional argument that if specified @@ -385,7 +387,7 @@ a valid language / country locale i.e. "en_US" or "en" - @type locale: c{unicode} or c{str} + @type locale: c{unicode} or ASCII c{str} @return c{unicode} value or None if not found """ @@ -426,7 +428,7 @@ The project name must be either an ASCII c{str} or c{unicode}. - @type project: c{str} or c{unicode} + @type project: ASCII c{str} or c{unicode} @param name: name is the key to lookup in a resource ini file to retrieve the @@ -436,7 +438,7 @@ The name must be either an ASCII c{str} or c{unicode}. - @type name: c{str} or c{unicode} + @type name: ASCII c{str} or c{unicode} @param locale: Optional argument that if specified @@ -447,7 +449,7 @@ a valid language / country locale i.e. "en_US" or "en" - @type locale: c{unicode} or c{str} + @type locale: c{unicode} or ASCII c{str} @return: c{bool} True if the name is found and the entry for that name is a valid directory @@ -500,7 +502,7 @@ The project name must be either an ASCII c{str} or c{unicode}. - @type project: c{str} or c{unicode} + @type project: ASCII c{str} or c{unicode} @param name: name is the key to lookup in a resource ini file to retrieve the @@ -510,7 +512,7 @@ The name must be either an ASCII c{str} or c{unicode}. - @type name: c{str} or c{unicode} + @type name: ASCII c{str} or c{unicode} @param locale: Optional argument that if specified @@ -521,7 +523,7 @@ a valid language / country locale i.e. "en_US" or "en" - @type locale: c{unicode} or c{str} + @type locale: c{unicode} or ASCII c{str} @return: c{List} of c{unicode} filenames """ @@ -586,7 +588,7 @@ The project name must be either an ASCII c{str} or c{unicode}. - @type project: c{str} or c{unicode} + @type project: ASCII c{str} or c{unicode} @param name: name is the key to lookup in a resource ini file to retrieve the @@ -596,7 +598,7 @@ The name must be either an ASCII c{str} or c{unicode}. - @type name: c{str} or c{unicode} + @type name: ASCII c{str} or c{unicode} @param locale: Optional argument that if specified @@ -607,7 +609,7 @@ a valid language / country locale i.e. "en_US" or "en" - @type locale: c{unicode} or c{str} + @type locale: c{unicode} or ASCII c{str} @return: c{bool} True if the name key points to at least one resource in an egg otherwise False. @@ -655,7 +657,7 @@ The project name must be either an ASCII c{str} or c{unicode}. - @type project: c{str} or c{unicode} + @type project: ASCII c{str} or c{unicode} @param name: name is the key to lookup in a resource ini file to retrieve the @@ -665,7 +667,7 @@ The name must be either an ASCII c{str} or c{unicode}. - @type name: c{str} or c{unicode} + @type name: ASCII c{str} or c{unicode} @param locale: Optional argument that if specified @@ -676,7 +678,7 @@ a valid language / country locale i.e. "en_US" or "en" - @type locale: c{unicode} or c{str} + @type locale: c{unicode} or ASCII c{str} @return: c{file} handle to the resource """ @@ -739,7 +741,7 @@ The project name must be either an ASCII c{str} or c{unicode}. - @type project: c{str} or c{unicode} + @type project: ASCII c{str} or c{unicode} @param name: name is the key to lookup in a resource ini file to retrieve the @@ -749,7 +751,7 @@ The name must be either an ASCII c{str} or c{unicode}. - @type name: c{str} or c{unicode} + @type name: ASCII c{str} or c{unicode} @param locale: Optional argument that if specified tells the method to only return True @@ -759,7 +761,7 @@ a valid language / country locale i.e. "en_US" or "en" - @type locale: c{unicode} or c{str} + @type locale: c{unicode} or ASCII c{str} @param encoding: The character set encoding of the @@ -768,7 +770,7 @@ in the file to c{unicode}. The default encoding is "UTF-8". - @type encoding: c{str} or c{unicode} + @type encoding: ASCII c{str} or c{unicode} @return: c{generator} list of non-blank non-comment c{unicode} lines. @@ -827,7 +829,7 @@ The project name must be either an ASCII c{str} or c{unicode}. - @type project: c{str} or c{unicode} + @type project: ASCII c{str} or c{unicode} @param name: name is the key to lookup in a resource ini file to retrieve the @@ -837,7 +839,7 @@ The name must be either an ASCII c{str} or c{unicode}. - @type name: c{str} or c{unicode} + @type name: ASCII c{str} or c{unicode} @param locale: Optional argument that if specified @@ -848,7 +850,7 @@ a valid language / country locale i.e. "en_US" or "en" - @type locale: c{unicode} or c{str} + @type locale: c{unicode} or ASCII c{str} @param encoding: The character set encoding of the resource file. This encoding will be @@ -856,7 +858,7 @@ in the file to c{unicode}. The default encoding is "UTF-8". - @type encoding: c{str} or c{unicode} + @type encoding: ASCII c{str} or c{unicode} @return: c{unicode} contents of the resource file. """ @@ -952,7 +954,7 @@ The project name must be either an ASCII c{str} or c{unicode}. - @type project: c{str} or c{unicode} + @type project: ASCII c{str} or c{unicode} @param name: name is the key to lookup in a resource ini file to retrieve the @@ -962,7 +964,7 @@ The name must be either an ASCII c{str} or c{unicode}. - @type name: c{str} or c{unicode} + @type name: ASCII c{str} or c{unicode} @param txt: The default text string which is used as look up key to retrieve a localized @@ -974,7 +976,7 @@ localizations of the English version with the English version as the key. - @type txt: c{str} or c{unicode} + @type txt: ASCII c{str} or c{unicode} @param args: An optional argument which if passed will be returned if no localzation @@ -1097,7 +1099,8 @@ codes. The value(s) must be able to be converted to ASCII. - @type localeSet: c{str} or c{unicode} or c{List} containing + @type localeSet: ASCII c{str} or c{unicode} or + c{List} containing ASCII c{str} or c{unicode} values @param fallback: Indicates whether locale set fallback should @@ -1639,7 +1642,7 @@ @param locale: a valid c{str} language / country code locale - @type locale: c{str} + @type locale: ASCII c{str} @return: c{str} with country code removed """ @@ -1654,7 +1657,7 @@ otherwise False. @param locale: a c{str} locale - @type locale: c{str} + @type locale: ASCII c{str} @return: c{boolean} True if locale contains country code otherwise False @@ -1675,7 +1678,7 @@ Only that the form of the c{str} is correct. @param locale: a c{str} locale - @type locale: c{str} + @type locale: ASCII c{str} @return: c{boolean} True if locale has a valid form otherwise False @@ -1707,7 +1710,7 @@ "fr" @param locale: a c{str} locale - @type locale: c{str} + @type locale: ASCII c{str} @return: c{str} normalized version of the locale. @@ -1735,7 +1738,7 @@ Thus if passed ["fr_CA", "en_US", "es"] this method would return ["fr_CA", "fr", "en_US", "en", "es"] - @param localeSet: a c{List} containing c{str} locales + @param localeSet: a c{List} containing ASCII c{str} locales @type localeSet: c{List} @return: c{List} containing original locale set c{str}'s @@ -1772,7 +1775,7 @@ would return "en_US" @param locale: a c{str} locale - @type locale: c{str} + @type locale: ASCII c{str} @return: c{str} stripped version of locale or original locale c{str} if no
_______________________________________________ Commits mailing list [email protected] http://lists.osafoundation.org/mailman/listinfo/commits
