Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Doc style preference #1029

Closed
Closed
Labels
questiontriagewaiting for initial maintainer review
@wyardley

Description

@wyardley

Question

I started looking at fixing some of the sphinx errors, but Ruff and sphinx started fighting over things like

Arguments:-----------

Then I realized that we don't have a standard docstring convention at all (also, in Google convention, at least, it's Args not Arguments, and it's not underlined). Many / most of the docs are in Sphinx style:

:param foo: ...:returns: xyz

While these don't have the explicit type hints that the other docs do, I checked, and Sphinx can infer those anyway, though it's harder to read directly in the code.

Is it safe to assume we want to move towards using Sphinx docs style?

Side note: Looks like ruffcurrently doesn't support sphinx docstyle

Metadata

Metadata

Assignees

No one assigned

    Labels

    questiontriagewaiting for initial maintainer review

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions


      [8]ページ先頭

      ©2009-2025 Movatter.jp