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

The Emoji component should have its dedicated documentation #20114

Open
stof opened this issue Aug 14, 2024 · 2 comments
Open

The Emoji component should have its dedicated documentation #20114

stof opened this issue Aug 14, 2024 · 2 comments
Labels
Emoji hasPR A Pull Request has already been submitted for this issue. help wanted Issues and PRs which are looking for volunteers to complete them.

Comments

@stof
Copy link
Member

stof commented Aug 14, 2024

currently, the documentation for the Emoji component is a section in the documentation page of the string component: https://symfony.com/doc/current/string.html#working-with-emojis

This is quite confusing given that this component does not rely on symfony/string (its input is a PHP string) nor has shortcuts in symfony/string at all (except in the Slugger, but this has a separate dedicated section in the page).

This documentation should be moved to a dedicated page (that could then become the documentation link used on https://symfony.com/components/Emoji)

@xabbuh xabbuh added the Emoji label Aug 14, 2024
@OskarStark OskarStark added the help wanted Issues and PRs which are looking for volunteers to complete them. label Aug 14, 2024
@smnandre
Copy link
Member

When we created the component, I made a PR with such a page (before its content was moved/fusionned in String)

Nothing amazing, but It could probably be a good starting point.

@smnandre
Copy link
Member

Update: found it #19489

@javiereguiluz javiereguiluz added the hasPR A Pull Request has already been submitted for this issue. label Sep 19, 2024
javiereguiluz added a commit that referenced this issue Sep 19, 2024
…(MrYamous)

This PR was squashed before being merged into the 7.1 branch.

Discussion
----------

[Emoji][String] Extract Emoji from String documentation

Give a try for #20114

I've mainly copy/paste current documentation, with following changes :

- change name for internal ref link (remove string part)
- remove a versionadded directive for Inverse Emoji Transliteration (Emoji component was added in 7.1, I think it's not necessary to indicate this feature has been add in 7.1 too)
- remove Gitlab and Slack example for transliterating services emojis as short code and replace it with a note to mention which services are available
- add a sentence about slug emojis as this part stay in String documentation

Commits
-------

2e11836 [Emoji][String] Extract Emoji from String documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Emoji hasPR A Pull Request has already been submitted for this issue. help wanted Issues and PRs which are looking for volunteers to complete them.
Projects
None yet
Development

No branches or pull requests

5 participants