Skip to content

Docstring examples not showing when using the Pylance languageserver #986

Description

@MarcSkovMadsen

hvplot==0.8.2

Unfortunately the examples of the docstrings in hvplot using ..code-block:: do not show in tooltips when using the Pylance language server. They do when using the Jedi language server which I use.

I can see Pandas uses <<< for code blocks

image

They show nicely with both the Pylance and Jedi language server.

Originally I used these. But using >>> just made copying of code snippets harder as you first have to remove the >>> before you can apply them. And I also thought using ..code-block:: was better for Sphinx documentation.

Is it OK I change ..code-block:: to >>> in the documentation @maximlt and others?

Activity

  1. added
    TRIAGERequires triage or initial assessment
    and removed
    TRIAGERequires triage or initial assessment
    on Nov 26, 2022
  2. maximlt commented on Nov 28, 2022

    @maximlt
    Member

    I think we need a more systematic approach here. We need to define clearly the environments we want to support. This is roughly going to include IDEs, notebooks, REPLs, and automated documentation. When this set is defined, we'll need to find the format that works best for these environments, maybe we'll have to make some tradeoffs and if so we'll need to clearly identify them. Once this is done we can propagate the convention found across HoloViz.

  3. added this to the 0.8.x milestone on Nov 28, 2022
  4. modified the milestones: 0.9.x, next on Sep 13, 2024
  5. locked and limited conversation to collaborators on May 12, 2025
  6. converted this issue into a discussion #1568 on May 12, 2025
  7. added theissue type on Sep 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions