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

FAQ Is tox supported? Outdated with tox v4 #8445

Closed
1 task done
adam-grant-hendry opened this issue Sep 15, 2023 · 6 comments
Closed
1 task done

FAQ Is tox supported? Outdated with tox v4 #8445

adam-grant-hendry opened this issue Sep 15, 2023 · 6 comments
Labels
area/docs Documentation issues/improvements

Comments

@adam-grant-hendry
Copy link

  • I have searched the issues of this repo and believe that this is not a duplicate.

Issue

The information in the FAQ regarding tox is outdated for tox v4 and above. Isolated builds are on by default now and several tox.ini keys have been removed.

This is a minor issue. At most, may warrant a small footnote to the docs in the event tox>=4 issues a warning when trying to set a non-existent key.

@adam-grant-hendry adam-grant-hendry added area/docs Documentation issues/improvements status/triage This issue needs to be triaged labels Sep 15, 2023
@finswimmer
Copy link
Member

@adam-grant-hendry A PR that updates the docs is always welcome 😃

@dimbleby
Copy link
Contributor

IMO, guidance and reaction to such issues should be stronger: please open a merge request, or close it out

I assert that if you care enough to raise an issue: then raising an issue but not opening a merge request is pointless.

  • Almost certainly no-one else will bother to do anything about it so nothing is achieved.
  • But the report is not wrong exactly - so it can't be rejected either, and will just sit around forever doing no good

(I might have made the same remark on any of maybe a hundred open issues: this is meant more as a comment on the general approach than on this one in particular)

@adam-grant-hendry
Copy link
Author

adam-grant-hendry commented Sep 16, 2023

@dimbleby This is an open-source project. I cannot demand you fix something nor you me. Your tone comes across rather rude, which I don't appreciate (though I could be misreading it).

If the maintainers do not want to address the issue, they are more than welcome to close any issue they please as a won't fix (unless something else I am unaware of is preventing them, though I don't see a CODE_OF_CONDUCT or any such instruction in the CONTRIBUTING guide...?). Also, it's only been several hours since I opened the issue...it's not likely I would open a pull request simultaneously.

Either way, bringing up an issue is not pointless. I'm simply bringing it to your attention. This could also be added to a project timeline or future to-do...there are many ways to utilize issues such as these. Berating a user for opening an issue is certainly not one of them.

If I have time and am willing, I will submit a pull request. Otherwise, a simple response like @finswimmer more than suffices to let me know you are welcome to me submitting a fix.

@dimbleby
Copy link
Contributor

dimbleby commented Sep 16, 2023

Neither of us is demanding that anyone fix anything. If you find my tone rude you are certainly misreading my intention. As I said, my remark might have been made in any of many issues: if anything it is meant more for finswimmer and other maintainers than for you.

From your point of view: I am advising that in my experience of contributing to and watching this project, opening a docs issue without a supporting MR is pointless, or very close to it. That's not saying that you're a bad person, or at fault for this - it's simply an assessment that the likely outcome will be: nothing happens.

In taking the trouble to figure out what you want the docs to say and engage with the project - you are doing the first 80% of the work, and will see maybe 1% of the desired result.

@radoering radoering removed the status/triage This issue needs to be triaged label Feb 4, 2024
@radoering
Copy link
Member

Resolved by #8658

Copy link

github-actions bot commented Mar 5, 2024

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/docs Documentation issues/improvements
Projects
None yet
Development

No branches or pull requests

4 participants