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

docs: rejected proposal the fuzzy strings #2128

Merged
merged 1 commit into from
Nov 21, 2023

Conversation

OmarIthawi
Copy link
Member

@OmarIthawi OmarIthawi commented Nov 4, 2023

Description

This adds an ADR for the rejected proposal of the #1944 pull request. Full details in the other pull request.

This contribution is part of the FC-0012 project which is sparked by the Translation Infrastructure update OEP-58.

@openedx-webhooks
Copy link

openedx-webhooks commented Nov 4, 2023

Thanks for the pull request, @OmarIthawi! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 4, 2023
@OmarIthawi OmarIthawi force-pushed the fuzzy-take-2 branch 2 times, most recently from a2023ce to c579c07 Compare November 4, 2023 16:32
@OmarIthawi OmarIthawi changed the title Fuzzy take 2 docs: rejected proposal the fuzzy strings Nov 4, 2023
@OmarIthawi
Copy link
Member Author

cc: @shadinaif

@OmarIthawi OmarIthawi marked this pull request as ready for review November 4, 2023 16:34
@OmarIthawi OmarIthawi force-pushed the fuzzy-take-2 branch 3 times, most recently from 8599611 to 0db8699 Compare November 4, 2023 18:12
Copy link
Contributor

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

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

This is looking great! I left a few suggestions (they look bigger than they are because of manual newlines).

Thank you so much for documenting this!

docs/decisions/0002-mark-fuzzy-entries.rst Outdated Show resolved Hide resolved
docs/decisions/0002-mark-fuzzy-entries.rst Outdated Show resolved Hide resolved
docs/decisions/0002-mark-fuzzy-entries.rst Outdated Show resolved Hide resolved
docs/decisions/0002-mark-fuzzy-entries.rst Outdated Show resolved Hide resolved
docs/decisions/0002-mark-fuzzy-entries.rst Outdated Show resolved Hide resolved
docs/decisions/0002-mark-fuzzy-entries.rst Outdated Show resolved Hide resolved
implementation: `mark invalid entries as fuzzy | FC-0012`_.


Proposed Design
Copy link
Contributor

Choose a reason for hiding this comment

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

It feels a little odd to me for this to come after the rejection section. Maybe it makes sense to move it up to be the first subsection under "Rejected Alternative"?

Copy link
Member Author

@OmarIthawi OmarIthawi Nov 20, 2023

Choose a reason for hiding this comment

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

Thanks @brian-smith-tcril for the review!!

The reason, I did that is that I wanted it to be clear that this design is rejected.

If it's not a blocker, I'd like to merge it after adding the other suggestions.

Copy link
Contributor

Choose a reason for hiding this comment

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

I figured having it under the "Rejected Alternative: Mark invalid entries as fuzzy" header would communicate that, but I'm fine either way.

Copy link
Member Author

Choose a reason for hiding this comment

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

I've reorganized it. Thanks again!!

@OmarIthawi OmarIthawi merged commit 6e13bf9 into openedx:main Nov 21, 2023
5 checks passed
@openedx-webhooks
Copy link

@OmarIthawi 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@itsjeyd itsjeyd added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Nov 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants