volcan01010 / bng Goto Github PK

Summary

As a BNG.py user, I want the typos in the README to be fixed so that I don't get confused about function names.

Description

There are multiple places were "osgb" is misspelled as "osbg36". These should be fixed.

Acceptance criteria

• All misspelled osbg36 strings are replaced with osgb36

Summary

As a BNG user, I want type hints on the function signatures so that my IDE can tell me what types to expect.

Description

Adding type hints (https://realpython.com/lessons/type-hinting/) helps IDEs with autocompletion and gives users information about what inputs they are required to provide.

Acceptance criteria

• to_osgb36 has type hints on the function signature
• from_osgb36 has type hints on the function signature

Acceptance criteria

• numpy is removed from requirements.txt. It is no longer needed.

Summary

As a BNG.py developer, I want to use doctests to ensure that the documentation is correct.

Description

Doctests run Python code given as examples in docstrings and confirms that the results are as expected.

https://docs.python.org/3/library/doctest.html

BNG has such code in the docstrings, but the tests have never been tried.

Acceptance

• Add if '__name__' == '__main__' section to allow easy running of doctests
• Confirm that doctests all pass

Summary

As a BNG user, I want the version numbers to be consistent so that I know which version I am using.

Description

The version in setup.py (1.0.5) is different to the version in bng.py (1.0.3) is different to the released version (1.0.4).

The version number in bng.py should be set to 1.0.5 and a release made of v1.0.5.

Acceptance criteria

• Released version 1.0.5 has v1.0.5 in both the setup.py and bng.py