8000 [Workflow] Support multiline descriptions in PlantUML by valtzu · Pull Request #51218 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Workflow] Support multiline descriptions in PlantUML #51218

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 0 commits into from
Closed

[Workflow] Support multiline descriptions in PlantUML #51218

wants to merge 0 commits into from

Conversation

valtzu
Copy link
Contributor
@valtzu valtzu commented Aug 1, 2023
Q A
Branch? 6.4
Bug fix? no
New feature? yes
Deprecations? no
License MIT

Instead of replacing new-line characters with spaces, let's render them as new lines as intended.

The behavior is described below (given description: My custom\nplace description for place a) 👇

Before:

(plantuml)

"place a" : My custom place description

image

After:

(plantuml)

"place a" : My custom
"place a" : place description

image

The behavior is described in https://plantuml.com/state-diagram#7d9e703ac421ea25

@valtzu valtzu requested a review from lyrixx as a code owner August 1, 2023 18:15
@carsonbot carsonbot added this to the 6.4 milestone Aug 1, 2023
@valtzu valtzu force-pushed the plantuml-multiline-description branch from 30b70e0 to 973dd8c Compare August 1, 2023 18:19
lyrixx
lyrixx reviewed Aug 1, 2023
View reviewed changes
Copy link
Member
@lyrixx lyrixx left a comment

Choose a reason for hiding this comment

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

Thanks 👍🏼 I let one little comment

@fabpot
Copy link
Member
fabpot commented Aug 2, 2023

Thank you @valtzu.

@fabpot fabpot mentioned this pull request Aug 2, 2023
Closed
fabpot added a commit that referenced this pull request Aug 2, 2023
@fabpot
feature #51218 [Workflow] Support multiline descriptions in PlantUML …
3303fa2 
…(valtzu)

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

Discussion
----------

[Workflow] Support multiline descriptions in PlantUML

| Q             | A
| ------------- | ---
| Branch?       | 6.4
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| License       | MIT

Instead of replacing new-line characters with spaces, let's render them as new lines as intended.

The behavior is described below (given `description: My custom\nplace description` for `place a`) 👇

**Before:**

_(plantuml)_
```
"place a" : My custom place description
```

![image](https://github.com/symfony/symfony/assets/652734/793ef82d-2dc8-4ad2-8d95-548fb7efccbc)

**After:**

_(plantuml)_
```
"place a" : My custom
"place a" : place description
```

![image](https://github.com/symfony/symfony/assets/652734/fc4d7ca3-7617-4b2f-a0fb-138e7b58b5cc)

---

The behavior is described in https://plantuml.com/state-diagram#7d9e703ac421ea25

Commits
-------

ed62914 [Workflow] Support multiline descriptions in PlantUML
@fabpot fabpot closed this Aug 2, 2023
@fabpot fabpot force-pushed the plantuml-multiline-description branch from 598721b to ed62914 Compare August 2, 2023 08:38
This was referenced Oct 21, 2023
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fabpot fabpot fabpot approved these changes

@lyrixx lyrixx lyrixx approved these changes

@stof stof stof approved these changes

Assignees
No one assigned
Labels
Feature Status: Reviewed Workflow
Projects
None yet
Milestone
6.4
Development

Successfully merging this pull request may close these issues.
5 participants
@valtzu @fabpot @lyrixx @stof @carsonbot
0