gh-153934: Correct documented param from n to width

[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.

• Issue: Documentation for weekheader names parameter incorrectly #153934

[read-the-docs-community]

Documentation build overview

📚 cpython-previews | 🛠️ Build #33645969 | 📁 Comparing b1db24d against main (0e81ef9)

  🔍 Preview build  

1 file changed

± library/calendar.html

[miss-islington-app]

Thanks @podmar for the PR, and @ZeroIntensity for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15.
🐍🍒⛏🤖

[tomasr8]

Thank you @podmar !!

[bedevere-app]

GH-153943 is a backport of this pull request to the 3.15 branch.

[bedevere-app]

GH-153944 is a backport of this pull request to the 3.14 branch.

[bedevere-app]

GH-153945 is a backport of this pull request to the 3.13 branch.