GithubHelp home page GithubHelp logo

Comments (1)

multimeric avatar multimeric commented on June 12, 2024

This is actually quite a difficult problem. I can transform the auto-generated mkdocstrings docs, but it's not clear if I should:

  • List out all types, which would be comprehensive but unreadable
  • Simplify the top-level literals such as the UniprotKB fields into a single list of options. This is possible, I wrote a transformer that does this, but it's not clear how to present this information. The rest of the docs present data structures in terms of Python code, but "a list of strings" isn't an actual data type we ever work with, in reality it's a type literal
  • Generate docs for the .search method of each dataset client separately, and add the list of options to the docstring. This might be user friendly, but the number of options (sometimes in the hundreds) might get unwieldy.

from unipressed.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.