gh-128481: Add missing documentation for traceback.FrameSummary.end_{col,line}

[Damien-Chen]

According to #128481, add missing documentation for end_lineno , colno and end_colno.

• Issue: Missing documentation for traceback.FrameSummary.end_{col,line}no attributes #128481

---

📚 Documentation preview 📚: https://cpython-previews--128484.org.readthedocs.build/en/128484/library/traceback.html#traceback.FrameSummary

[ZeroIntensity]

There's also an undocumented colno parameter that goes before end_colno. You can go ahead and document it too with this PR.

[Damien-Chen]

Understood, I made the order of arguments of documentation consistent with the order of code, and it would like this
` .. attribute:: FrameSummary.end_lineno

  The last line number of the source code for this frame.

.. attribute:: FrameSummary.colno

  The column number of the source code for this frame.

.. attribute:: FrameSummary.end_colno

  The last column number of the source code for this frame.`

[picnixz]

.. class:: FrameSummary(filename, lineno, end_lineno=None, name, lookup_line=True, locals=None, line=None, end_colno=None)

This is an illegal prototype. end_lineno cannot have a default None while name has no default. In addition, lookup_line are keyword-only:

    def __init__(self, filename, lineno, name, *, lookup_line=True,
            locals=None, line=None,
            end_lineno=None, colno=None, end_colno=None):

Let's just copy the __init__ signature for the docs.

[picnixz]

.. class:: FrameSummary(filename, lineno, end_lineno=None, name, lookup_line=True, locals=None, line=None, end_colno=None)

This is an illegal prototype. end_lineno cannot have a default None while name has no default. In addition, lookup_line are keyword-only:

    def __init__(self, filename, lineno, name, *, lookup_line=True,
            locals=None, line=None,
            end_lineno=None, colno=None, end_colno=None):

Let's just copy the __init__ signature for the docs.

[Damien-Chen]

end_lineno cannot have a default None as well ?

There is no description for the colno, end_lineno and endcolno in the __init__ function, should I add the documentation for all the above argument ?

`
.. attribute:: FrameSummary.end_lineno

  The last line number of the source code for this frame.

.. attribute:: FrameSummary.colno

  The column number of the source code for this frame.

.. attribute:: FrameSummary.end_colno

  The last column number of the source code for this frame.

`

[picnixz]

end_lineno cannot have a default None as well ?

No, I meant it cannot have a default value without name having one. The problem was where it was put in the signature.

[Damien-Chen]

Understood, I have fixed it with latest commit.

[picnixz]

Suggested change

	.. class:: FrameSummary(filename, lineno, name, lookup_line=True, locals=None, line=None, end_lineno=None, colno=None, end_colno=None)
	.. class:: FrameSummary(filename, lineno, name, *,\
	lookup_line=True, locals=None,\
	line=None, end_lineno=None, colno=None, end_colno=None)

Actually, the current (docs) signature as the code expect lookup_line and remaining parameters to be keyword only so let's also fix that here.

[picnixz]

Those new attributes can be None I think (just check the source code first). If so, this should be specified. Also, it'd be good to say whether it's a 0-indexed or 1-indexed base (I always forget)

[Damien-Chen]

Based on the code description, those new attributes can be None that is right.
And those number attributes are 1-indexed base I think.

Changes were made.