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

SPEC 0: Soften explicit drop schedule. #273

Merged
merged 8 commits into from
Oct 9, 2023

Conversation

Carreau
Copy link
Contributor

@Carreau Carreau commented Oct 2, 2023

This does only change the presenting of the drop information:

  • reduplicate when the same package was released twice in the same quarter.
  • Remove the day of month. I don't think it helps conveying the flexibility that the spec

--

This also regenerate the files

This does only change the presenting of the drop information:

 - reduplicate when the same package was released twice in the same
   quarter.
 - Remove the day of month. I don't think it helps conveying the
   flexibility that the spec
@Carreau Carreau changed the title Soften explicit drop schedule. SPEC-0000: Soften explicit drop schedule. Oct 2, 2023
@jarrodmillman
Copy link
Member

The format of spec-0000/schedule.md needs to be fixed. It doesn't pass the linting and I suspect the rendered text isn't what you intended:
2023-10-02T10:05:37,451492976-07:00

You may want to use the yamltotable shortcode:
https://theme.scientific-python.org/shortcodes/#yamltotable

@Carreau
Copy link
Contributor Author

Carreau commented Oct 2, 2023

Yeah, I'm trying 4 spaces to have pre blocks, it's not the best.

Screenshot 2023-10-02 at 19 17 44

I'm going to see if it supports tables.

@munkm
Copy link
Member

munkm commented Oct 2, 2023

Remove the day of month. I don't think it helps conveying the flexibility that the spec

I think this is a good idea and I'm in support of this change.

Something I've been thinking about with respect to the flexibility of this SPEC is the implications of the word "drop". I wonder if we add language saying that "drop" doesn't mean explicitly removing support, but rather not continuing support for that versioning. What do you think?

ETA: Whoops. I see that conversation is already happening in #272

@Carreau
Copy link
Contributor Author

Carreau commented Oct 2, 2023

Better as a table:

Screenshot 2023-10-02 at 19 38 53

Copy link
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

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

I really like the cleaner look of your table solution than what we currently have.

2026 – Quarter 4:

- 01 Oct 2026: drop python 3.12 (initially released on Oct 02, 2023)
#### 2023 - Quarter 4:
Copy link
Member

Choose a reason for hiding this comment

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

I feel that the previous quarter could be kept around for a bit of an overlap.

- 01 Oct 2026: drop python 3.12 (initially released on Oct 02, 2023)
#### 2023 - Quarter 4:

Recommend drop support for:
Copy link
Member

Choose a reason for hiding this comment

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

The rendered version could maybe benefit from a tiny bit of different formatting, either leaving more space between this line and the table itself, or making this line with a different typeface (italic should be enough, no need to make it a heading).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, spacing need css change, as prettify reformat the markdown anyway.

Copy link
Member

Choose a reason for hiding this comment

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

what about #273 (comment) then?

Copy link
Member

Choose a reason for hiding this comment

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

You can put the markdown inside of

<!-- prettier-ignore-start -->

and

<!-- prettier-ignore-end -->

to prevent prettier from messing with your formatting.

Feel free to let @alphapapa know if you would like any css updates to the theme. You are also welcome to just make a PR if you prefer.

spec-0000/SPEC0_versions.py Outdated Show resolved Hide resolved
Carreau and others added 2 commits October 4, 2023 00:31
Co-authored-by: Brigitta Sipőcz <b.sipocz@gmail.com>
@Carreau
Copy link
Contributor Author

Carreau commented Oct 4, 2023

I've tried reading 1 quarter in the past.

@bsipocz
Copy link
Member

bsipocz commented Oct 4, 2023

I quite like what I see under the current preview link, not sure why prettier doesn't like it though.

@stefanv
Copy link
Member

stefanv commented Oct 5, 2023

Easiest is to run the generated result through prettier and look at the resulting diff.

@jarrodmillman
Copy link
Member

Or ask the pre-commit bot to autofix it.

@stefanv
Copy link
Member

stefanv commented Oct 5, 2023

If it's for a generated file, you'd have to run that each time you produce the file.

@jarrodmillman
Copy link
Member

jarrodmillman commented Oct 5, 2023

Here is what prettier does. For example, it changes this

|    |    |    |
|----|----|----|
|ipython        |7.26.0 to 7.28.0   |released Aug 2021 and Sep 2021|
|networkx       |2.6                |released Jul 2021|
|pandas         |1.3.0              |released Jul 2021|
|scikit-learn   |1.0                |released Sep 2021|
|xarray         |0.19.0             |released Jul 2021|

to

|              |                  |                                |
| ------------ | ---------------- | ------------------------------ |
| ipython      | 7.26.0 to 7.28.0 | released Aug 2021 and Sep 2021 |
| networkx     | 2.6              | released Jul 2021              |
| pandas       | 1.3.0            | released Jul 2021              |
| scikit-learn | 1.0              | released Sep 2021              |
| xarray       | 0.19.0           | released Jul 2021              |

I would update the script to just generate the table so that prettier is happy. It might be easiest to use something like:
https://pypi.org/project/tabulate/

@jarrodmillman
Copy link
Member

There is a blank line at the end of schedule.md that I still need to fix. After that, this should be ready to go.

@jarrodmillman
Copy link
Member

@Carreau @bsipocz I removed the final blank line in 201e923. The CI is passing now and the tables are formatted in the new style. I am sure the code can be improved. Feel free to fix my commits or just delete them and fix the PR in a different way.

@jarrodmillman jarrodmillman changed the title SPEC-0000: Soften explicit drop schedule. SPEC 0: Soften explicit drop schedule. Oct 9, 2023
Copy link
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

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

The rendering looks good to me so I keep my approval for merging as I don't have strong opinions on how the code archives that
(I have the feeling that the astropy fixed width ascii table writer could recreate something like these in much fewer lines, but don't think it would be worth the effort of rewriting everything)

@jarrodmillman jarrodmillman merged commit 1219611 into scientific-python:main Oct 9, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants