bpo-33014: Clarify str.isidentifier docstring (GH-6088)

CuriousLearner · willingc · commit ffc5a14d00db · 2018-10-08T12:23:32.000+05:30
* bpo-33014: Clarify str.isidentifier docstring * bpo-33014: Add code example in isidentifier documentation
diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
@@ -1700,8 +1700,19 @@ expression support in the :mod:`re` module).
    Return true if the string is a valid identifier according to the language
    definition, section :ref:`identifiers`.
 
-   Use :func:`keyword.iskeyword` to test for reserved identifiers such as
-   :keyword:`def` and :keyword:`class`.
+   Call :func:`keyword.iskeyword` to test whether string ``s`` is a reserved
+   identifier, such as :keyword:`def` and :keyword:`class`.
+
+   Example:
+   ::
+
+      >>> from keyword import iskeyword
+
+      >>> 'hello'.isidentifier(), iskeyword('hello')
+      True, False
+      >>> 'def'.isidentifier(), iskeyword('def')
+      True, True
+
 
 .. method:: str.islower()
 
diff --git a/Objects/clinic/unicodeobject.c.h b/Objects/clinic/unicodeobject.c.h
diff --git a/Objects/unicodeobject.c b/Objects/unicodeobject.c
@@ -12100,13 +12100,13 @@ str.isidentifier as unicode_isidentifier
 
 Return True if the string is a valid Python identifier, False otherwise.
 
-Use keyword.iskeyword() to test for reserved identifiers such as "def" and
-"class".
+Call keyword.iskeyword(s) to test whether string s is a reserved identifier,
+such as "def" or "class
 [clinic start generated code]*/
 
 static PyObject *
 unicode_isidentifier_impl(PyObject *self)
-/*[clinic end generated code: output=fe585a9666572905 input=916b0a3c9f57e919]*/
+/*[clinic end generated code: output=fe585a9666572905 input=2fb643aafbcf0e1c]*/
 {
     return PyBool_FromLong(PyUnicode_IsIdentifier(self));
 }

Original file line number	Diff line number	Diff line change
`@@ -12100,13 +12100,13 @@ str.isidentifier as unicode_isidentifier`
`12100`	`12100`
`12101`	`12101`	`Return True if the string is a valid Python identifier, False otherwise.`
`12102`	`12102`
`12103`		`-Use keyword.iskeyword() to test for reserved identifiers such as "def" and`
`12104`		`-"class".`
	`12103`	`+Call keyword.iskeyword(s) to test whether string s is a reserved identifier,`
	`12104`	`+such as "def" or "class`
`12105`	`12105`	`[clinic start generated code]*/`
`12106`	`12106`
`12107`	`12107`	`static PyObject *`
`12108`	`12108`	`unicode_isidentifier_impl(PyObject *self)`
`12109`		`-/[clinic end generated code: output=fe585a9666572905 input=916b0a3c9f57e919]/`
	`12109`	`+/[clinic end generated code: output=fe585a9666572905 input=2fb643aafbcf0e1c]/`
`12110`	`12110`	`{`
`12111`	`12111`	`return PyBool_FromLong(PyUnicode_IsIdentifier(self));`
`12112`	`12112`	`}`