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

remove notes-to-self #3117

Merged
merged 7 commits into from
Dec 18, 2024
Merged

remove notes-to-self #3117

merged 7 commits into from
Dec 18, 2024

Conversation

jakkdl
Copy link
Member

@jakkdl jakkdl commented Oct 20, 2024

notes-to-self can now be viewed at https://github.com/python-trio/trio/wiki/notes-to-self

I don't think these are used by anybody in any way anymore? They mostly just seem to mess with linters/formatters and increase the size of the codebase by 200KB.
If we do want to keep them around for more visibility somewhere, and people actually expect to use and/or update them once in a blue mood, we could consider putting them in a separate repo in the python-trio org?

teamspen suggested making a tag. We could make a dedicated notes-to-self tag, but for now I just reused the 0.27.0 tag.

@jakkdl jakkdl added the skip newsfragment Newsfragment is not required label Oct 20, 2024
Copy link

codecov bot commented Oct 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.62%. Comparing base (c4c8ce4) to head (7b8881a).
Report is 15 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3117   +/-   ##
=======================================
  Coverage   99.62%   99.62%           
=======================================
  Files         122      122           
  Lines       18405    18405           
  Branches     1226     1226           
=======================================
  Hits        18336    18336           
  Misses         47       47           
  Partials       22       22           
Files with missing lines Coverage Δ
src/trio/_core/_io_windows.py 98.80% <ø> (ø)
src/trio/_highlevel_open_tcp_listeners.py 100.00% <ø> (ø)

@jakkdl
Copy link
Member Author

jakkdl commented Oct 30, 2024

does anybody have any opinions? @A5rocks @njsmith @Zac-HD @oremanj @graingert

@graingert
Copy link
Member

You could git commit them into the wiki https://github.com/python-trio/trio/wiki

@jakkdl
Copy link
Member Author

jakkdl commented Nov 25, 2024

You could git commit them into the wiki https://github.com/python-trio/trio/wiki

that's a good idea, done: https://github.com/python-trio/trio/wiki/notes-to-self

@graingert
Copy link
Member

You could git commit them into the wiki python-trio/trio/wiki

that's a good idea, done: Wiki: notes to self

Ah I meant to include the history also, eg with filter branch

@graingert
Copy link
Member

You could git commit them into the wiki python-trio/trio/wiki

that's a good idea, done: Wiki: notes to self

Ah I meant to include the history also, eg with filter branch

Resolved to link to the merged commit back from the wiki in DM

@graingert graingert requested a review from CoolCat467 November 25, 2024 11:54
@jakkdl
Copy link
Member Author

jakkdl commented Nov 25, 2024

You could git commit them into the wiki python-trio/trio/wiki

that's a good idea, done: Wiki: notes to self

Ah I meant to include the history also, eg with filter branch

I think this would only be necessary/useful if we completely wiped the notes-to-self directory from the repository (which I don't think is necessary, while it's 7% of current files it's going to have less impact on the the size of the history since the files have rarely been changed). But I'll add a link to the wiki with the merge commit in case people do want to git blame

@jakkdl jakkdl requested a review from A5rocks November 25, 2024 11:57
Copy link
Member

@CoolCat467 CoolCat467 left a comment

Choose a reason for hiding this comment

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

Looks good

Copy link
Contributor

@A5rocks A5rocks left a comment

Choose a reason for hiding this comment

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

Could you also add notes-to-self/ to a .gitignore? This pattern still might be nice to test any new features while adding them.

@jakkdl
Copy link
Member Author

jakkdl commented Dec 9, 2024

Could you also add notes-to-self/ to a .gitignore? This pattern still might be nice to test any new features while adding them.

Done. While I think it's unlikely somebody would create a directory with that exact name to play around with stuff, having people restore the files from history / download them from the wiki seems like a decent use-case.

I'll merge this in a bit (and update wiki to refer to the PR) unless anybody has any objections. :)

@jakkdl jakkdl enabled auto-merge December 12, 2024 14:22
@jakkdl jakkdl disabled auto-merge December 12, 2024 14:22
@jakkdl jakkdl added this pull request to the merge queue Dec 18, 2024
Merged via the queue into python-trio:main with commit b10c043 Dec 18, 2024
38 checks passed
@jakkdl jakkdl deleted the remove_notes_to_self branch December 18, 2024 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
project meta skip newsfragment Newsfragment is not required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants