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

Formats number string in quotes. #5543

Closed
wants to merge 9 commits into from

Conversation

sainthkh
Copy link
Contributor

User facing changelog

Formats number strings in test results in quotes. In other words, 25 -> '25'.

Additional details

Why was this change necessary:

The ASSERT error (in red background) on the commands UI does not signify whether my value is a string or not.

What is affected by this change?

Not much. I just decaffeinated some files to work easily and added a test to show this case clearly.

Any implementation details to explain?

Not much.

As codes have been decaffeinated, I guess it is not recommended to be squashed. It should be rebased or merged.

How has the user experience changed?

Before: above.

After:
Screenshot from 2019-10-31 08-49-10

PR Tasks

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Oct 30, 2019

Thanks for the contribution! Below are some guidelines Cypress uses when doing PR reviews.

  • Please write [WIP] in the title of your Pull Request if your PR is not ready for review - someone will review your PR as soon as the [WIP] is removed.
  • Please familiarize yourself with the PR Review Checklist and feel free to make updates on your PR based on these guidelines.

PR Review Checklist

If any of the following requirements can't be met, leave a comment in the review selecting 'Request changes', otherwise 'Approve'.

User Experience

  • The feature/bugfix is self-documenting from within the product.
  • The change provides the end user with a way to fix their problem (no dead ends).

Functionality

  • The code works and performs its intended function with the correct logic.
  • Performance has been factored in (for example, the code cleans up after itself to not cause memory leaks).
  • The code guards against edge cases and invalid input and has tests to cover it.

Maintainability

  • The code is readable (too many nested 'if's are a bad sign).
  • Names used for variables, methods, etc, clearly describe their function.
  • The code is easy to understood and there are relevant comments explaining.
  • New algorithms are documented in the code with link(s) to external docs (flowcharts, w3c, chrome, firefox).
  • There are comments containing link(s) to the addressed issue (in tests and code).

Quality

  • The change does not reimplement code.
  • There's not a module from the ecosystem that should be used instead.
  • There is no redundant or duplicate code.
  • There are no irrelevant comments left in the code.
  • Tests are testing the code’s intended functionality in the best way possible.

Internal

  • The original issue has been tagged with a release in ZenHub.

@CLAassistant
Copy link

CLAassistant commented Oct 30, 2019

CLA assistant check
All committers have signed the CLA.

@sainthkh sainthkh changed the title Formats number string in quotes. [WIP] Formats number string in quotes. Oct 31, 2019
@sainthkh sainthkh closed this Oct 31, 2019
@sainthkh
Copy link
Contributor Author

sainthkh commented Oct 31, 2019

Which one do you prefer, decaffeinated PR or coffee(#5544) PR?

Failed flaky test below is fixed by #5546.

@sainthkh sainthkh reopened this Oct 31, 2019
@sainthkh sainthkh changed the title [WIP] Formats number string in quotes. Formats number string in quotes. Oct 31, 2019
@jennifer-shehane
Copy link
Member

@sainthkh We prefer to have decaffeinated PRs as separate PRs from actual code work. If you can make a separate PR for decaffeinating files, then open a new PR after that is merged with the code changes. Evaluating decaffeinations with changes to code is more difficult.

@jennifer-shehane
Copy link
Member

Also, the final result of this PR does not look like the exact desired result either, with the multiple quotations. I think this has something to do with how we format markdown? I'm not sure.

@sainthkh
Copy link
Contributor Author

sainthkh commented Oct 31, 2019

Added #5556 as a decaffeination part for this PR.

Fixed the quotation marks problem in #5557.

@sainthkh sainthkh mentioned this pull request Oct 31, 2019
1 task
@sainthkh sainthkh closed this Oct 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Commands UI assert errors should clearly delineate integers from strings.
3 participants