📝 Document how to use context in examples
#3458
Conversation
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 866a8e9:
|
Codecov Report
@@ Coverage Diff @@
## main #3458 +/- ##
==========================================
- Coverage 95.51% 95.49% -0.02%
==========================================
Files 213 213
Lines 5842 5842
Branches 1076 1076
==========================================
- Hits 5580 5579 -1
- Misses 262 263 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
Great! I believe this will make users' lives much easier. However, I still strongly urge that eventually fast-check itself will output counter examples that are copy-pastable. As a very crude approximation, it can even output this very code itself, such as |
|
The PR does not pass, you'll need to run Regarding the:
As the owner and maintainer of the repository I receive urgency by no-one. The project is made on free time without any funding today. If you really care about it, start funding the project and maybe I'll work on it. But today, it does not pay me at all and I will clearly not spend one second on such a second zone issue that will bring more harm than it fixes. And once again, the repository being open source, if you get better ideas than someone having worked on the project for more than 5 years now, just fork it or wait. |
Ah, my apologies, I was confused by the CONTRIBUTING.md document, it seemed like I wouldn't have to do anything since I didn't do a code change. I have now set it to "decline" since there is no change to the code, let me know if that was wrong or if there is something else I have to do in addition!
I'm sorry if that is how it came across, I meant to use the phrase "to urge someone" which means "to strongly recommend". I have no urgency for any fix as I already have my workaround, and I am indeed doing this PR only in the hopes that future people will be able to use this fine library without having to crawl through closed issues. I do still strongly recommend, and indeed urge you to consider, to take issues with usability seriously. That is a concern of high importance for many development teams around the world, especially those who are careful about the dependencies they want to take on. In that light, having two first class features in your library that do not work together, is a bad look. This is merely my personal opinion, I am only sharing it because I want the best for the project. What you do with that is up to you, and I respect what ever decision you come to. |
dubzzz
changed the title
exampleContext to docscontext in examples
|
Seems that formatting is not passing |
|
Ah thanks for telling me. Not sure if that was what was breaking it since it didn't give me any error message other than the filename, but this should I work I think. Let me know if there is anything else! |
This PR addresses the issue raised here. I would prefer a proper fix in the library itself, but this at least gives the users the tools to circumvent the bug themselves!
I have added the suggested piece of code and short explanation to both parts of the docs so that they're easy to find. The idea is that users shouldn't have to stumble over this and have to dig through old issues to potentially find a fix, and can ideally be warned early enough that they circumvent the issue all together.
Please feel free to suggest better, friendlier, or clearer wording, or other places I should add this as well!
Category:
Potential impacts: