Skip to content

Commit f00edbc

Browse files
author
Ang
committed
docs: fix residual doc issues from pyOpenSci review (#6, #11, #28, #31, #32)
While closing the pyOpenSci review issues, a handful of places were missed. This commit finishes the cleanup: #6 README / docs/index.rst / docs/faq.rst no longer advertise OpenAlex and dblp as data sources - they were never wired into the code. Replaced with the sources that *are* actually queried (OpenAIRE/BASE, GitHub, Google Scholar). #11 docs/api/pipeline.rst was still describing classes and methods that do not exist (Validator / Identifier / Completer / Formatter, set_source_priority, set_timeout, add_template_path, routing based on 'medical' vs 'CS' queries). Rewritten to match the real ParserModule / IdentifierModule / EnricherModule / FormatterModule surface and the actual confidence-based identification logic. #28 README quick-start example used 'journal = arXiv preprint' inside an @inproceedings entry - exactly the symptom the issue reported. Fixed by using 'booktitle = Advances in Neural Information Processing Systems (NeurIPS)'. Same fix applied to docs/quick_start.rst. #31/#32 APA and MLA renderers were removed, but several docs and docstrings still advertised them. Updated docs/output_formats.rst (rewritten BibTeX-only), docs/faq.rst, docs/quick_start.rst, docs/python_api.rst, docs/templates.rst, docs/index.rst and docstrings in core.py / formatter.py to only mention BibTeX. Users wanting APA/MLA are pointed at pandoc / citeproc-py. No code behavior changed.
1 parent 9be0085 commit f00edbc

10 files changed

Lines changed: 295 additions & 636 deletions

File tree

CHANGELOG.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,31 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/), and this
77
## [Unreleased]
88

99
### Changed
10+
- Split monolithic ``pipeline.py`` (~3000 lines) into a proper
11+
``onecite/pipeline/`` package with one module per stage
12+
(``parser.py`` / ``identifier.py`` / ``enricher.py`` /
13+
``formatter.py``) plus a ``_utils.py`` for shared helpers (#17).
14+
Public imports (``from onecite.pipeline import IdentifierModule``)
15+
and mocking targets (``patch("onecite.pipeline.requests.get", ...)``)
16+
continue to work unchanged.
1017
- Unify CrossRef request and parsing methods in pipeline (#26)
1118

19+
### Fixed
20+
- README no longer advertises OpenAlex and dblp as data sources — they
21+
were never wired into the code (#6).
22+
- README quick-start example now shows ``booktitle`` (NeurIPS) instead
23+
of ``journal = "arXiv preprint"`` for the ``@inproceedings`` sample
24+
(#28).
25+
- ``docs/api/pipeline.rst`` rewritten to match the actual module
26+
structure; removed references to classes and methods that never
27+
existed (``Validator`` / ``Identifier`` / ``Completer`` / ``Formatter``,
28+
``set_source_priority``, ``set_timeout``, ``add_template_path``) (#11).
29+
- ``docs/output_formats.rst``, ``docs/faq.rst``, ``docs/quick_start.rst``,
30+
``docs/python_api.rst``, ``docs/templates.rst``, ``docs/index.rst`` and
31+
docstrings in ``core.py`` / ``formatter.py`` no longer advertise
32+
APA / MLA output — the renderers were removed and the CLI rejects
33+
those values (#31, #32).
34+
1235
## [0.1.0] - 2025-02-09
1336

1437
### Added

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,7 @@ OneCite solves this by accepting **any mix of identifiers and text queries** and
7878

7979
[![CrossRef](https://img.shields.io/badge/CrossRef-B31B1B?style=for-the-badge&logo=crossref&logoColor=white)](https://www.crossref.org/)
8080
[![Semantic Scholar](https://img.shields.io/badge/Semantic-1857B6?style=for-the-badge&logo=semanticscholar&logoColor=white)](https://www.semanticscholar.org/)
81-
[![OpenAlex](https://img.shields.io/badge/OpenAlex-FF6B35?style=for-the-badge&logo=openalex&logoColor=white)](https://openalex.org/)
8281
[![PubMed](https://img.shields.io/badge/PubMed-326599?style=for-the-badge&logo=pubmed&logoColor=white)](https://pubmed.ncbi.nlm.nih.gov/)
83-
[![dblp](https://img.shields.io/badge/dblp-002B5B?style=for-the-badge&logo=dblp&logoColor=white)](https://dblp.org/)
8482
[![arXiv](https://img.shields.io/badge/𝒳_arXiv-B31B1B?style=for-the-badge)](https://arxiv.org/)
8583
[![DataCite](https://img.shields.io/badge/DataCite-00B4A0?style=for-the-badge&logo=datacite&logoColor=white)](https://datacite.org/)
8684
[![Zenodo](https://img.shields.io/badge/Zenodo-0A0E4A?style=for-the-badge&logo=zenodo&logoColor=white)](https://zenodo.org/)
@@ -150,7 +148,7 @@ Your `results.bib` file now contains entries of different types.
150148
title = "Attention Is All You Need",
151149
author = "Vaswani, Ashish and Shazeer, Noam and Parmar, Niki and Uszkoreit, Jakob and Jones, Llion and Gomez, Aidan N. and Kaiser, Lukasz and Polosukhin, Illia",
152150
year = 2017,
153-
journal = "arXiv preprint",
151+
booktitle = "Advances in Neural Information Processing Systems (NeurIPS)",
154152
url = "https://arxiv.org/abs/1706.03762",
155153
}
156154
# ... and 5 more entries ...

0 commit comments

Comments
 (0)