Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

allow documenter symbols within quoted blocks #182

Merged
merged 2 commits into from
Jun 7, 2020
Merged

Conversation

ZacLN
Copy link
Contributor

@ZacLN ZacLN commented Jun 6, 2020

closes #180

@ZacLN ZacLN added the bug label Jun 6, 2020
@ZacLN ZacLN added this to the Next extension patch release milestone Jun 6, 2020
@ZacLN ZacLN self-assigned this Jun 6, 2020
@davidanthoff davidanthoff merged commit 30159d7 into master Jun 7, 2020
@davidanthoff davidanthoff deleted the quote-docs branch June 7, 2020 21:11
@timholy
Copy link

timholy commented Jun 13, 2020

Thanks for fixing #180, but I have to gently complain that its test case was not included in this PR. There are absolutely times when it's a pain in the neck to write tests, but this was a case where all that was required was to copy/paste the reproducer and then check the result.

#166 calls for better test coverage, but this is the kind of change that won't affect coverage, because you were already running that line. Yet you know for certain that it was broken for specific inputs, so the coverage report should not be interpreted as a reason to stop worrying. If next year someone goes to rewrite some aspect of that block of code, now you've lost all guarantees that anything that worked formerly will continue to work.

For me it was an eye-opener to hear someone tell me to write the tests first, watch them fail, and then make the fix. I'm sure there are many sources to get this kind of advocacy from, but https://www.youtube.com/watch?v=HhwElTL-mdI (first ~15 minutes) is funny and well-put. I am not a "religious" person and so I never adopt anything unreservedly---for example, sometimes it's hard to isolate a sufficiently minimal test until you've started poking at the bug---but elements of TDD really do (once absorbed) make you not just safer, but actually faster.

@ZacLN
Copy link
Contributor Author

ZacLN commented Jun 14, 2020

Hi Tim, of course I can add a test. I'm not unenlightened to the benefits of of extensive set of tests (this package tests the validity of ~500,000 comparisons against the scheme parser's output) but am often pushed for time.

@davidanthoff
Copy link
Member

One thing I would really love is a code coverage information that is not based on lines but on branches :) We have a lot of if clauses with quite complicated conditions, and in some sense the line based coverage information is really quite misleading for that kind of situation.

The text at https://marketplace.visualstudio.com/items?itemName=alexdima.vscode-lcov makes me think that the lcov file format somehow even supports that concept? I guess that is really something that would have to happen in Base, of course.

@oppo-source oppo-source removed the request for review from a team April 16, 2021 07:34
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Parsing docstrings on same line as definition inside a quote
3 participants