astropy / astropy/sphinx-automodapi

Add more test cases

Open
#4 1 comment 0 reactions 0 assignees View on GitHub
help wanted
Dominant language
Python
Stars
67
Forks
48
Avg merge
11h 52m
Merged PRs (30d)
1

Description

We should add more test cases (similar to those added in https://github.com/astropy/sphinx-automodapi/pull/3) that test the following options:

* ``:allowed-package-names:``
* ``:inherited-members:``
* ``:no-inherited-members:``

This will increase the test coverage further. I don't have any longer to work on this, so if anyone else is interested in trying to do this, just leave a comment.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the test cases added in pull request #3 and locate the existing tests for the Sphinx extension. Add comparable coverage for :allowed-package-names:, :inherited-members:, and :no-inherited-members:, then run the test suite to confirm these options are exercised.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.