Athemis/doi2dataset
1
0
Fork 0
Code Issues Pull requests Projects Releases 3 Packages Wiki Activity Actions

docs: fix list formatting in docstrings

Browse source 
Add proper spacing before lists in docstrings to ensure correct
rendering in sphinx API documentation:
- Fix package functionality list in __init__.py
- Fix environment variable list in config.py

This prevents lists from being rendered as run-on text in the
generated API reference documentation.
This commit is contained in:
Alexander Minges 2025-07-25 09:56:00 +02:00
parent 81aa1cc9f3
commit 5e6601a873
Signed by: Athemis
SSH key fingerprint: SHA256:TUXshgulbwL+FRYvBNo54pCsI0auROsSEgSvueKbkZ4
2 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doi2dataset/__init__.py
View file

@ -2,12 +2,14 @@
doi2dataset: A tool to process DOIs and generate metadata for Dataverse datasets. doi2dataset: A tool to process DOIs and generate metadata for Dataverse datasets.
This package provides functionality to: This package provides functionality to:
- Validate and process DOIs - Validate and process DOIs
- Fetch metadata from external APIs (OpenAlex, CrossRef) - Fetch metadata from external APIs (OpenAlex, CrossRef)
- Generate Dataverse-compatible metadata - Generate Dataverse-compatible metadata
- Upload datasets to Dataverse instances - Upload datasets to Dataverse instances
The package is organized into several modules: The package is organized into several modules:
- core: Configuration, models, and metadata field definitions - core: Configuration, models, and metadata field definitions
- api: API clients and processors - api: API clients and processors
- processing: Business logic for citation building and metadata processing - processing: Business logic for citation building and metadata processing

1
doi2dataset/core/config.py
View file

@ -41,6 +41,7 @@ class Config:
Singleton class to handle configuration loading and retrieval. Singleton class to handle configuration loading and retrieval.
Supports environment variable overrides for Dataverse configuration: Supports environment variable overrides for Dataverse configuration:
- DATAVERSE_URL: Overrides dataverse.url - DATAVERSE_URL: Overrides dataverse.url
- DATAVERSE_API_TOKEN: Overrides dataverse.api_token - DATAVERSE_API_TOKEN: Overrides dataverse.api_token
- DATAVERSE_DATAVERSE: Overrides dataverse.dataverse - DATAVERSE_DATAVERSE: Overrides dataverse.dataverse