twosigma / twosigma/marbles

docstrings as a note

Open
#63 5 comments 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
155
Forks
22
PR merge metrics
No merged PRs in 30d

Description

**Is your feature request related to a problem? Please describe.**
This might be a thing in our team, but we *really* like docstrings. When a unit-test fails our current team relies on reliable docstrings to explain what is happening in a test. This is nice, because sometimes code is a language that is too cryptic to explain **why** a test is important

**Describe the solution you'd like**
I must admit that I'm just starting out with the project and there's parts that I love. I really enjoy the locals view in a failed test. But instead of notes, we might be interested in seeing the doctoring attached to the testing method. This might be a highly preferential thing on our team, but may just be worth considering.

**Describe alternatives you've considered**
Part of this problem could be explained with a note but a docstring feels like a more natural place to write a long part of text.

**Additional context**
This definitely falls into the nice-to-have category, something that one would only see if a certain flag is passed from the command line (like `--verbose`). We're curious what the thoughts are on your side.

ps. Thanks again for speaking at PyData Amsterdam.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.