Comments (1)
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)
- Improve docstrings for "duplicate" fields like `xref` which has many value prefixes
- Move `include_isoform` to `uniprotkb` only
- Better type annotations for `each_record()` HOT 1
- Support automatic parsing of more formats
- Better handling for ranges
- Investigate using Pydantic models
- Fix missing fields listed only in the autocomplete HOT 1
- Integrate the OpenAPI spec
- Implement a Python API for the entry retrieval API HOT 1
- Support the `/uniprotkb/{accession}/publications` and ` /uniprotkb/{accession}/interactions` endpoints
- Support the stream API for all search endpoints
- Support the `/genecentric` endpoints HOT 1
- Support ID Mapping Requests
- Error calling get_status() on IdMappingClient request HOT 3
- idmapping sleep/ wait HOT 10
- Add FormatType to the docs, and any other missing Literals
- Add `include_isoform` parameter HOT 2
- Fix the constructor documentation HOT 1
- Clarify which files are auto-generated
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from unipressed.