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

CI/CD: Tox -> Nox: Deprecate tox and related documentation updates #1720

Closed
wants to merge 3 commits into from

Conversation

insspb
Copy link
Member

@insspb insspb commented Jun 8, 2022

Closes #1697

  • Deprecates tox
  • Update related contribution docs
  • Reformat CONTRIBUTING.md
  • Roadmap information is also removed, as not actual completely

@insspb insspb added documentation This issue/PR relates to or includes documentation. deprecated Feature or component marked as deprecated and will be removed labels Jun 8, 2022
@insspb insspb self-assigned this Jun 8, 2022
@github-actions github-actions bot added the CI/CD This issue/PR relates to the project CI/CD update or fix. label Jun 8, 2022
@insspb insspb changed the title Deprecate tox CI/CD: Tox -> Nox: Deprecate tox and related documentation updates Jun 8, 2022
@insspb insspb added the needs-review PR Only: This PR require review from other developer label Jun 8, 2022
@jensens
Copy link
Contributor

jensens commented Jun 8, 2022

Please stick to one sentence per line. We want to be inclusive and having translatable docs is important.

Further reading

And as YT: Svens talks and deep experience in documentation is great, like here (there are more) https://www.youtube.com/watch?v=N4kyGM3IYfo

Just believe me, documentation is not code. Here PEP8 does not apply, but rules that make sense for docs. Like one-sentence per-line.

@jensens jensens requested a review from ericof June 8, 2022 19:42
@insspb
Copy link
Member Author

insspb commented Jun 8, 2022

@jensens

  • I already commented and explained one line issues in Documentation overhaul #1677. And oneliners was implemented there. If I saw it before I never be agreed with this change. You decided and done, now you try to force it without reason.
  • This is markdown file that could and should be readd from vscode, pycharm or other editor as helper and reminder... And what to do with 320 symbols in line?
  • Any already translated documentation?
  • Any issue with request for translation?

Inclusive is good, but completely not related to one line.

Technical documentation should be clear from any device, with any screen, without moving mouse.

This PR implement 88 symbols, same as in black.

@jensens
Copy link
Contributor

jensens commented Jun 8, 2022

Thus, I value your coding experience. But stick to your hi standard for documentation as well. Its not an opinion, it docs-qualitty I am talking about,

Docs are not, code, no black here, no PEP8. It is that easy. I can not accept the PR here. Sorry.

@jensens
Copy link
Contributor

jensens commented Jun 8, 2022

  1. I dont force, its docs standard, stick to high standards?
  2. 340 per line? Rephrase, nobody would read it
  3. Inclusiveness produces translatable documentation. You wont find a translator if docs does not enable it.

So, why are you taking docs like code? Its just wrong. Its it not.

@insspb
Copy link
Member Author

insspb commented Jun 8, 2022

@jensens I am not arguing that this practice (one line) exist. I am sure, that this practice is not acceptable here at current step. This brings more complexity for working with docs. Docs require correct content at this point. As content will not be stable quite long.

Now I just opened three popular projects. Raw files. How many symbols inside?

So let's not reinvent a bike.

@jensens
Copy link
Contributor

jensens commented Jun 8, 2022

Come on, it does add complexity to not add manual linebreaks? Sorry, I did the work already, just stick to it. It makes it simpler. We are exact at this point. You started formatting back.

Its that easy, write whole sentences and add a line break at the end of it.

Its simpler than anything we do here.

Btw.: since you remove the Makefile in docs you also removed "make gettext". So, actually you removed a Sphinx default feature.

@ericof
Copy link
Member

ericof commented Jun 9, 2022

@insspb
First, I do not see a reason to move from tox to nox, and I think this should be discussed more with the rest of the community. So let's get back to the issue and discuss there.
Second, please follow the guidelines @jensens mentioned about contributing to documentation.

@ericof ericof closed this Jun 9, 2022
@ericof ericof reopened this Jun 9, 2022
@ericof
Copy link
Member

ericof commented Jun 9, 2022

Sorry, closed this by mistake.

@jensens
Copy link
Contributor

jensens commented Jun 9, 2022

@ericof FYI @insspb already self-merged some PRs and introduced nox w/o obtaining consensus. I am +/i0 on nox vs. tox on technical level.
But given this project is declared as a conservative one, I would have complained, because tox is a well known tool while nox is a niche.

@kurtmckee
Copy link
Member

@jensens @ericof Please close this PR. There is no need to move from tox to nox.

@jensens jensens closed this Jun 12, 2023
@jensens jensens deleted the deprecate-tox branch June 12, 2023 10:55
@ericof
Copy link
Member

ericof commented Jun 13, 2023

We just need now to decide if we keep nox or not

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD This issue/PR relates to the project CI/CD update or fix. deprecated Feature or component marked as deprecated and will be removed documentation This issue/PR relates to or includes documentation. needs-review PR Only: This PR require review from other developer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CI/CD: Tox -> Nox
4 participants