astropy / astropy/pyvo

MAINT: consolidate namespace

Open
#407 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
88
Forks
64
Avg merge
38m
Merged PRs (30d)
1

Description

The documentation showcases the API endpoint of `vo.registry.search`, all the while, the top level namespace provides the same as `regsearch`.
I think this is a rather unfortunate and possibly confusing setup and we should instead aim to avoid providing multiple API endpoints for the same functionality.

OTOH, if people feel strongly for the need of `vo.regsearch`, then we should make that the official API endpoint and rework all the docs to use that, and only that.

Contributor guide

No contributing guide indexed for this repository

Research direction

Compare the documented vo.registry.search endpoint with the top-level regsearch and the proposed vo.regsearch endpoint. First resolve which single public API should remain, then update the documentation consistently and verify that only the chosen endpoint is presented.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, documentation
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.