Documentation for weekheader names parameter incorrectly

[podmar]

Documentation

Documentation contains the following signature:

.. function:: weekheader(n)

   Return a header containing abbreviated weekday names. *n* specifies the width in
   characters for one weekday.

In reality the function uses "width" as the parameter name:

def formatweekheader(self, width):
        """
        Return a header for a week.
        """
        header = super().formatweekheader(width)
        theme = self._get_theme().calendar
        return f"{theme.weekday}{header}{theme.reset}"

Documentation in the calendar.rst file should be updated to reflect the actual implementation.

Linked PRs

• gh-153934: Correct documented param from n to width #153942
• [3.15] gh-153934: Correct documented paramemeter in calendar.weekheader from n to width (GH-153942) #153943
• [3.14] gh-153934: Correct documented paramemeter in calendar.weekheader from n to width (GH-153942) #153944
• [3.13] gh-153934: Correct documented paramemeter in calendar.weekheader from n to width (GH-153942) #153945

[ZeroIntensity]

Backports on auto-merge