DOC:GH34026 (#34059)

* DOC:GH34026

* DOC:Fixing desc. for  Series.str.rstrip() and Series.str.lstrip() (#34026)

* DOC:Removed text strings from lstrip and rstrip. Added a new %position item to each dict. (pandas-dev34026)

* DOC:Fixed strip so %position now reads leading and trailing. Built documentation locally to confirm changes (pandas-dev34026)

Co-authored-by: Lesley <[email protected]>

Author: 2 people

pandas/core/strings.py

@@ -2975,7 +2975,7 @@ def encode(self, encoding, errors="strict"):
     _shared_docs[
         "str_strip"
     ] = r"""
-    Remove leading and trailing characters.
+    Remove %(position)s characters.
 
     Strip whitespaces (including newlines) or a set of specified characters
     from each string in the Series/Index from %(side)s.
@@ -3038,20 +3038,29 @@ def encode(self, encoding, errors="strict"):
     """
 
     @Appender(
-        _shared_docs["str_strip"] % dict(side="left and right sides", method="strip")
+        _shared_docs["str_strip"]
+        % dict(
+            side="left and right sides", method="strip", position="leading and trailing"
+        )
     )
     @forbid_nonstring_types(["bytes"])
     def strip(self, to_strip=None):
         result = str_strip(self._parent, to_strip, side="both")
         return self._wrap_result(result)
 
-    @Appender(_shared_docs["str_strip"] % dict(side="left side", method="lstrip"))
+    @Appender(
+        _shared_docs["str_strip"]
+        % dict(side="left side", method="lstrip", position="leading")
+    )
     @forbid_nonstring_types(["bytes"])
     def lstrip(self, to_strip=None):
         result = str_strip(self._parent, to_strip, side="left")
         return self._wrap_result(result)
 
-    @Appender(_shared_docs["str_strip"] % dict(side="right side", method="rstrip"))
+    @Appender(
+        _shared_docs["str_strip"]
+        % dict(side="right side", method="rstrip", position="trailing")
+    )
     @forbid_nonstring_types(["bytes"])
     def rstrip(self, to_strip=None):
         result = str_strip(self._parent, to_strip, side="right")