Skip to content

Document Unit Tests #1739

Open
Open
@robertmclaws

Description

@robertmclaws

I spent the past weekend going over the unit tests in this project, and kudos for the work that has gone into making the system much more reliable by increasing code coverage.

One thing that jumps out at me, however, is a lack of documentation on how the tests work, and what they are actually testing. I have found that explaining tests helps to make sure they are well-defined and properly constrained. But the OData unit tests often leave the end user trying to decipher what is really going on, with no guarantee that the tests are thorough or complete.

Take this test class, for example. These tests are public methods that leverage several inputs to test parameters... but there are zero XML documentation comments explaining what the parameters are or how they work. This makes it really difficult for anyone outside the team to contribute to contribute additional test cases or bug fixes in any meaningful way.

I understand there is a lot of architecture to build, and you've done a lot of work to get us here. But help us help you ;)

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions