Skip to content

More documentation problems #619

Open
@lockwo

Description

@lockwo

While there are still problems with the rendering of the new math ops (see #594), I found what I think is another documentation problem on the tfq website. The descriptions for the attributes of tfq.datasets.spin_system.SpinSystemInfo (https://www.tensorflow.org/quantum/api_docs/python/tfq/datasets/spin_system/SpinSystemInfo) are all missing. This is the only place on the tfq website where the little description boxes have labels but no descriptions (see the attached picture to if this explanation is not clear).
image
Additionally, since the attribute descriptions exist in the code (see https://github.com/tensorflow/quantum/blob/v0.5.1/tensorflow_quantum/datasets/spin_system.py#L25) I assume this is a bug.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/docsConcerns documentation – problems, ideas, requestskind/bug-reportSomething doesn't seem to work

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions