Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Docstring of phases displays phase descriptor

オープン
  • 何か問題がありますか？
#877 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

  • #878 @Minipada による — マージされずにクローズ

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
python
領域
documentation

調査の方向性

提供されている OpenHTF の例を実行し、Sphinx が処理する前にデコレーター @htf.measures が hello_world.doc をどのように変更するかを確認します。フェーズディスクリプターとドキュメントのエントリーポイントを追跡し、生成されたドキュメントにディスクリプターのテキストだけでなく、フェーズ関数の docstring が表示されることを検証します。

索引モデルが issue の本文から書いたものです。

説明

I'm trying to generate a sphinx documentation of my apps but the only output I get from my phase documentation is the phase descriptor class.

This is what I'm running:

#!/usr/bin/env python
"""OPENHTF based motor control test"""
from __future__ import division, print_function
import openhtf as htf

@htf.measures(htf.Measurement('hello_world_measurement'))
def hello_world(test):
  """A hello world test phase."""
  test.logger.info('Hello World!')
  test.measurements.hello_world_measurement = 'Hello Again!'


if __name__ == '__main__':
    print(hello_world.__doc__)
    pass

This is the output:

Phase function and related information.

  Attributes:
    func: Function to be called (with TestApi as first argument).
    options: PhaseOptions instance.
    plugs: List of PhasePlug instances.
    measurements: List of Measurement objects.
    extra_kwargs: Keyword arguments that will be passed to the function.
    code_info: Info about the source code of func.

I guess something is broken, do you know what it could be?

主要言語
Python
スター
725
フォーク
240
平均マージ
3日 14時間
マージ済み PR（30日）
10

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

google/openhtf のほかの issue

google/openhtf の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。