Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

docs: add note on removeInterceptor usage #2035

Merged
merged 1 commit into from
Nov 7, 2021
Merged

Conversation

Alexsey
Copy link
Contributor

@Alexsey Alexsey commented Jul 1, 2020

The fact that removeInterceptor works on some chains and doesn't work on other chains is very confusing because it means that existing code may break while the behavior is getting only extended (opposit to modified). Also, because documentation is not giving a clear difference on what chain methods returns what type of values. There are a bunch of issues on it:
#1822
#1117
#600

@Alexsey Alexsey changed the title Add note on removeInterceptor usage docs: add note on removeInterceptor usage Jul 1, 2020
@mastermatt
Copy link
Member

Thanks for this @Alexsey, this question/confusion has come up several times on Github and Stackoverflow.

The verbiage doesn't seem quite right, however. Unfortunately, I'm no wordsmith so I won't even bother with a "suggestion" comment. In the past, I've relied on @paulmelnikow to help me out on these things. Maybe he can throw in his two cents.

@Alexsey
Copy link
Contributor Author

Alexsey commented Jul 5, 2020

There are two other solutions:

  1. Allow removeInterctptor to accept Scope
  2. Mention types all over the documentation

I don't feel myself a wordsmith either + I'm not even an English native speaker. So if you have any suggestions I would be glad to consider adding them to the PR

@stale
Copy link

stale bot commented Oct 3, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. We try to do our best, but nock is maintained by volunteers and there is only so much we can do at a time. Thank you for your contributions.

The fact that `removeInterceptor` works on some chains and doesn't work on other chains is very confusing because it means that existing code may break while the behavior is getting only extended (opposite to modified). Also, because documentation is not giving a clear difference on what chain methods returns what type of values. There are a bunch of issues on it:
nock#1822
nock#1117
nock#600
@stale
Copy link

stale bot commented Jan 10, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. We try to do our best, but nock is maintained by volunteers and there is only so much we can do at a time. Thank you for your contributions.

@stale stale bot added the stale label Jan 10, 2021
@Alexsey
Copy link
Contributor Author

Alexsey commented Jan 10, 2021

@mastermatt I have made some improvements to the wording in October. If you still think it has some issues, maybe someone would make a PR for this in the future?

@stale stale bot removed the stale label Jan 10, 2021
@stale
Copy link

stale bot commented Jun 18, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. We try to do our best, but nock is maintained by volunteers and there is only so much we can do at a time. Thank you for your contributions.

@stale stale bot added the stale label Jun 18, 2021
@Alexsey
Copy link
Contributor Author

Alexsey commented Jun 19, 2021

The issue is still relevant, don't close

@stale stale bot removed the stale label Jun 19, 2021
Copy link
Member

@gr2m gr2m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this change is better than what we have :) Sorry to make you wait for so long @Alexsey. I'll be working on nock a bit over the coming weeks and hope to catch up with open issues and PRs, and share a plan / priorities for nock's future

@gr2m gr2m merged commit 63a5482 into nock:main Nov 7, 2021
@github-actions
Copy link

github-actions bot commented Nov 8, 2021

🎉 This PR is included in version 13.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants