Skip to content

fix(python): indent the docstrings of client methods - #319

Closed
moetemp wants to merge 2 commits into
moe/up/python-empty-request-signaturefrom
moe/up/python-caller-docstring-indent
Closed

moetemp wants to merge 2 commits into
moe/up/python-empty-request-signaturefrom
moe/up/python-caller-docstring-indent

Conversation

@moetemp

@moetemp moetemp commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

What changed?

This PR indents the docstring of a Python <Service>Client method at the method body, not at the module function indent. A service with no @nexus.endpoint gets that class.

The first commit documents notify-all in user-service with today's output, and the second is the fix.

It replaces moetemp#60.
It's based on #318.

Why?

A @nexus.doc or @nexus.experimental on an operation of such a service made services.py fail to parse.

How did you test it?

Link to a test plan if any -

  • Unit Tests
  • Staging
  • End to End Tests

The Python user-service test checks the docstring of notify_all.

This was referenced Oct 28, 2026
@moetemp
moetemp force-pushed the moe/up/python-empty-request-signature branch from 4b930b3 to 8765209 Compare October 29, 2026 04:00
@moetemp
moetemp force-pushed the moe/up/python-caller-docstring-indent branch from 451fef4 to 78851a5 Compare October 29, 2026 04:00
@moetemp
moetemp force-pushed the moe/up/python-empty-request-signature branch from 8765209 to 8045102 Compare October 29, 2026 06:28
@moetemp
moetemp force-pushed the moe/up/python-caller-docstring-indent branch from 78851a5 to 2a68fff Compare October 29, 2026 06:28
@moetemp moetemp changed the title fix(python): indent the docstrings of caller methods fix(python): indent the docstrings of client methods Oct 29, 2026
@moetemp
moetemp force-pushed the moe/up/python-caller-docstring-indent branch from 2a68fff to c0884a7 Compare October 29, 2026 07:00
@moetemp
moetemp force-pushed the moe/up/python-empty-request-signature branch from 8045102 to 93e1d90 Compare October 29, 2026 07:00
Python's client method takes the docstring indent of a module function, so its services.py
doesn't parse and the Python output keeps its previous content.
The client of a service with no endpoint took the docstring indent of a module function, so a
documented or experimental operation broke the module. The user-service client generates with
the doc of `notify_all`.
@moetemp
moetemp force-pushed the moe/up/python-caller-docstring-indent branch from c0884a7 to a5ce60d Compare October 29, 2026 07:35
@moetemp
moetemp force-pushed the moe/up/python-empty-request-signature branch from 93e1d90 to 9ec3d43 Compare October 29, 2026 07:35
@moetemp

moetemp commented Oct 29, 2026

Copy link
Copy Markdown
Contributor Author

Closing this. The Streams stack doesn't need it.

@moetemp moetemp closed this Oct 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant