Skip to content

Metadata missing for one Qiskit SDK API file #66

@Eric-Arellano

Description

@Eric-Arellano

These never had front matter. Axel said it's fine for now, but we should improve it soon.

Please fix these files: docs/api/qiskit-ibm-provider/ibm-provider.md,docs/api/qiskit/transpiler_builtin_plugins.md,docs/api/qiskit-ibm-runtime/ibm-runtime.md

We need to an else clause here:

if (result.meta.python_api_name) {
result.markdown = `---
title: ${getLastPartFromFullIdentifier(result.meta.python_api_name)}
description: API reference for ${result.meta.python_api_name}
in_page_toc_min_heading_level: 1
python_api_type: ${result.meta.python_api_type}
python_api_name: ${result.meta.python_api_name}
---
${markdown}
`;
}

TBD how we determine the title and description!

Update: make sure CI enforces it, per #793.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions