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

Standardize "@example.com" as domain in documentation #124

Merged
merged 4 commits into from Mar 16, 2021

Conversation

ThomasLandauer
Copy link
Member

example.com is the "official" domain for such things: http://example.com/

For the removal, see #120 (comment)

`example.com` is the "official" domain for such things: http://example.com/

For the removal, see Codeception#120 (comment)
@TavoNiievez
Copy link
Member

If you want to standardize @ example.com as the official domain for examples that's fine with me, however, doing a bit of Ctrl + F on the documentation page I can see that:

  • amLoggedInAs has 'john_doe@gmail.com',
  • fillField has 'jon@mail.com', (this one comes from InnerBrowser, so you'd have to send a PR there to change it).
  • grabSentEmails has 'john_doe@user.com',
  • submitSymfonyForm has 'john_doe@gmail.com'.

Please update them all to be able to approve and merge this PR.

@TavoNiievez TavoNiievez changed the title Update MailerAssertionsTrait.php Standardize "@example.com" as a domain in the doc examples Mar 16, 2021
@TavoNiievez TavoNiievez changed the title Standardize "@example.com" as a domain in the doc examples Standardize "@example.com" as a domain in documentation Mar 16, 2021
@TavoNiievez TavoNiievez changed the title Standardize "@example.com" as a domain in documentation Standardize "@example.com" as domain in documentation Mar 16, 2021
@ThomasLandauer
Copy link
Member Author

There you go - I hope I got 'em all :-)

BTW: For changes like this, it would be really handy to have a direct link from each function on the docs page to the source code, as I suggested at Codeception/Codeception#6063 (comment)
What do you think? Who could add this? @Arhell too?

@TavoNiievez
Copy link
Member

TavoNiievez commented Mar 16, 2021

For changes like this, it would be really handy to have a direct link from each function on the docs page to the source code

I know what you mean. But the symfony module is currently the only one that has traits for functions, so this change would only be for this module.

Previously only this:

imagen

was enough because all the documentation was in the same file, but this is no longer the case.

Who could add this? Arhell too?

Are you in the Slack of Codeception? Sadly I don't have an answer for that either.

@TavoNiievez TavoNiievez added this to the 2.0.1 milestone Mar 16, 2021
@TavoNiievez TavoNiievez merged commit 6be648a into Codeception:master Mar 16, 2021
@ThomasLandauer ThomasLandauer deleted the patch-7 branch March 16, 2021 14:29
@TavoNiievez TavoNiievez modified the milestones: 2.0.1, 2.0.0 Mar 28, 2021
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.

None yet

2 participants