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

fix: redundant word in banner for Legacy stream documents #7207

Merged
merged 3 commits into from
Aug 5, 2024

Conversation

richsalz
Copy link
Collaborator

This does all the changes suggested by @rjsparks in #6902 and a little bit more cleanup

Copy link

codecov bot commented Mar 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.77%. Comparing base (c7f6bde) to head (0e72c7e).
Report is 20 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7207      +/-   ##
==========================================
- Coverage   88.78%   88.77%   -0.02%     
==========================================
  Files         296      296              
  Lines       41320    41338      +18     
==========================================
+ Hits        36687    36698      +11     
- Misses       4633     4640       +7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@rjsparks rjsparks left a comment

Choose a reason for hiding this comment

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

See inline comments

@@ -14042,7 +14042,7 @@
},
{
"fields": {
"desc": "Legacy stream",
"desc": "Legacy",
Copy link
Member

Choose a reason for hiding this comment

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

This won't actually change production. it will show up here as a side-effect of the change in the database instead. The PR will need a data migration to change the name.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Got it. It will take me a few days to re-understand the migration stuff. If you want to add a commit or hints to me, feel free. (Not asking, just not wanting to be a blocker if I don't have to be)

Copy link
Member

Choose a reason for hiding this comment

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

No worries, this can wait awhile

@NGPixel NGPixel changed the title Fix 6902 fix: redundant word in banner for Legacy stream documents Mar 21, 2024
@rjsparks rjsparks self-requested a review July 25, 2024 20:13
rjsparks
rjsparks previously approved these changes Jul 25, 2024
Copy link
Member

@jennifer-richards jennifer-richards left a comment

Choose a reason for hiding this comment

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

Just a minor nit - I'm ok with committing as is or making the change.

else:
stream_desc = "(None)"
stream = "(None)"
stream = ("draft-stream-" + doc.stream.slug) if doc.stream != None else "(None)"
Copy link
Member

Choose a reason for hiding this comment

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

nit: "is not None" instead of "!= None"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

There are seven "!= None" and four "is not None" in the file. Let me know if you want to standardize on one.

Copy link
Member

Choose a reason for hiding this comment

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

Should definitely be is not None (citation: https://peps.python.org/pep-0008/#programming-recommendations)

We're not obsessively zealous about it, but I try to rephrase things as I encounter them and it'd be great if you don't mind cleaning these up!

fix: Change "Legacy stream" to "Legacy"

chore: Add "stream" to stream.desc as needed

Fixes: ietf-tools#6902
The stream_desc key isn't used in template/doc/docuemnt_draft.html to
don't pass it in nor compute it

Fixes: ietf-tools#6902
Copy link
Member

@jennifer-richards jennifer-richards left a comment

Choose a reason for hiding this comment

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

Having a little trouble following the history because of the force pushing, but it looks like at some point there had been a migration to make the change on production that Robert had suggested and it was taken out?

I think it needs that unless we're planning to make the change through the admin, which would not be unreasonable since it's a single value.

Aside from that, lgtm.

@rjsparks
Copy link
Member

rjsparks commented Aug 2, 2024

I built and pushed a migration - I suspect Rich missed that and didn't merge back into his branch.
Rich - can you cherry pick it from the history, or do you want me to do that and push that commit back in here again?

@richsalz
Copy link
Collaborator Author

richsalz commented Aug 3, 2024

@rjsparks if you push the commit, then I'll probably leave this untouched as @jennifer-richards basically approved and I'll just keep my hands off :)

@rjsparks
Copy link
Member

rjsparks commented Aug 5, 2024

for other PRs - if someone else commits to richsalz/datatracker <PR branch>, remember to pull those before rebasing. Also consider never rebasing unless something has gone horribly wrong - rather, just merge main into your work.

@rjsparks
Copy link
Member

rjsparks commented Aug 5, 2024

migration cherry-picked back into the PR

@richsalz
Copy link
Collaborator Author

richsalz commented Aug 5, 2024

consider never rebasing

sorry for that. Old habit I picked up with OpenSSL, the first place I learned git.

@rjsparks rjsparks merged commit 8a5826a into ietf-tools:main Aug 5, 2024
9 checks passed
@richsalz richsalz deleted the fix-6902 branch August 5, 2024 15:28
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants