Skip to content

Improve formatting of API examplesΒ #513

Open
@ansjmoody

Description

@ansjmoody

πŸ“ Description of the feature

In order to make it easier for users to copy/paste the examples, it is desired to improve the formatting of the API examples.

Currently, most examples do not use >>> for every line of code in the example.
However, this makes it cumbersome to copy the example on the website.

The desire is to add >>> for every line of code in the example. Doing so allows a user to copy the example from the website and paste it into a script and run it.
This also facilitates development.

For example, instead of this:
>>> sherlock.project.import_odb_archive(
"ODB++ Tutorial.tgz",
True,
True,
True,
True,
project="Test",
cca_name="Card",
)

Do this:
>>> sherlock.project.import_odb_archive(
>>> "ODB++ Tutorial.tgz",
>>> True,
>>> True,
>>> True,
>>> True,
>>> project="Test",
>>> cca_name="Card",
>>>)

πŸ’‘ Steps for implementing the feature

No response

πŸ”— Useful links and references

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions