NCAS-CMS / NCAS-CMS/cf-python

New tests for deprecated features

Open
#509 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

testing
Dominant language
Python
Stars
150
Forks
23
Avg merge
1d 11h
Merged PRs (30d)
2

Description

It would be nice to have a suit of tests for all of the _DEPRECATED_* exceptions that trap deprecated features such as keyword arguments or their values.

It is suggested to have a new file (e.g. cf/tests/test_depreacted.py) that contains these for all classes. When it is time to remove the feature entirely, and hence the trap, the corresponding test will start to fail, and can be easily deleted, too.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing DEPRECATED* exceptions and the classes that use them, then create the proposed cf/tests/test_depreacted.py file. Cover deprecated features such as keyword arguments and their values across all classes. Done means each deprecated-feature trap has a test that will fail when the corresponding trap is removed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.