google / google/openhtf

Printing docstring on the web frontend

Open
#1,000 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
722
Forks
237
Avg merge
11h 31m
Merged PRs (30d)
4

Description

Hi! I am wondering how I can modify the openhtf code to print the test phase docstring on the web frontend?

![Docstring screenshot](https://user-images.githubusercontent.com/12185630/161299401-c0017f21-069e-4cbb-bf22-14796e760138.png)

For multi-line docstring, only the first line is shown. The rest of the docstrings are shown when we click the "expand all" button on the web frontend.

I know this is achievable because I have seen it work on a forked project https://gitlab.com/tackv/spintop-openhtf . In fact, I have been using spintop until the underlying company (TackV GmBH) went out of business last year.

Reference:
https://gitlab.com/tackv/spintop-openhtf/-/blob/master/docs/docs/doc/documenting.md#L6

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.