minor #21324 [FrameworkBundle] Fix third level headers for MarkdownDescriptor (ogizanagi)

fabpot · fabpot · commit 1dfb1080b297 · 2017-01-17T12:04:54.000-08:00
This PR was merged into the 2.7 branch. Discussion ---------- [FrameworkBundle] Fix third level headers for MarkdownDescriptor | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | N/A | License | MIT | Doc PR | N/A `~` is not valid as an underlining char when using markdown on the contrary of reStructuredText. See the rendering of [builder_1_public.md (before)](https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/builder_1_public.md) vs [builder_1_public.md (after)](https://github.com/ogizanagi/symfony/blob/fix/2.7/fwb/md_third_lvl_headers/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/builder_1_public.md) for instance. This PR fixes it by using a third level header. ~~**EDIT:** There is no BC break. Wrong PR template information.~~ Commits ------- ce29ab1 [FrameworkBundle] Fix third level headers for MarkdownDescriptor
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php
@@ -233,7 +233,7 @@ protected function describeContainerDefinition(Definition $definition, array $op
             }
         }
 
-        $this->write(isset($options['id']) ? sprintf("%s\n%s\n\n%s\n", $options['id'], str_repeat('~', strlen($options['id'])), $output) : $output);
+        $this->write(isset($options['id']) ? sprintf("### %s\n\n%s\n", $options['id'], $output) : $output);
     }
 
     /**
@@ -244,7 +244,7 @@ protected function describeContainerAlias(Alias $alias, array $options = array()
         $output = '- Service: `'.$alias.'`'
             ."\n".'- Public: '.($alias->isPublic() ? 'yes' : 'no');
 
-        $this->write(isset($options['id']) ? sprintf("%s\n%s\n\n%s\n", $options['id'], str_repeat('~', strlen($options['id'])), $output) : $output);
+        $this->write(isset($options['id']) ? sprintf("### %s\n\n%s\n", $options['id'], $output) : $output);
     }
 
     /**
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/builder_1_public.md b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/builder_1_public.md
@@ -4,8 +4,7 @@ Public services
 Definitions
 -----------
 
-definition_1
-~~~~~~~~~~~~
+### definition_1
 
 - Class: `Full\Qualified\Class1`
 - Scope: `container`
@@ -21,14 +20,12 @@ definition_1
 Aliases
 -------
 
-alias_1
-~~~~~~~
+### alias_1
 
 - Service: `service_1`
 - Public: yes
 
-alias_2
-~~~~~~~
+### alias_2
 
 - Service: `service_2`
 - Public: no
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/builder_1_services.md b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/builder_1_services.md
@@ -4,8 +4,7 @@ Public and private services
 Definitions
 -----------
 
-definition_1
-~~~~~~~~~~~~
+### definition_1
 
 - Class: `Full\Qualified\Class1`
 - Scope: `container`
@@ -17,8 +16,7 @@ definition_1
 - Factory Class: `Full\Qualified\FactoryClass`
 - Factory Method: `get`
 
-definition_2
-~~~~~~~~~~~~
+### definition_2
 
 - Class: `Full\Qualified\Class2`
 - Scope: `container`
@@ -41,14 +39,12 @@ definition_2
 Aliases
 -------
 
-alias_1
-~~~~~~~
+### alias_1
 
 - Service: `service_1`
 - Public: yes
 
-alias_2
-~~~~~~~
+### alias_2
 
 - Service: `service_2`
 - Public: no
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/builder_1_tag1.md b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/builder_1_tag1.md
@@ -4,8 +4,7 @@ Public and private services with tag `tag1`
 Definitions
 -----------
 
-definition_2
-~~~~~~~~~~~~
+### definition_2
 
 - Class: `Full\Qualified\Class2`
 - Scope: `container`
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/builder_1_tags.md b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/builder_1_tags.md
@@ -4,8 +4,7 @@ Container tags
 tag1
 ----
 
-definition_2
-~~~~~~~~~~~~
+### definition_2
 
 - Class: `Full\Qualified\Class2`
 - Scope: `container`
@@ -22,8 +21,7 @@ definition_2
 tag2
 ----
 
-definition_2
-~~~~~~~~~~~~
+### definition_2
 
 - Class: `Full\Qualified\Class2`
 - Scope: `container`

Original file line number	Diff line number	Diff line change
`@@ -233,7 +233,7 @@ protected function describeContainerDefinition(Definition $definition, array $op`
`233`	`233`	`}`
`234`	`234`	`}`
`235`	`235`
`236`		`- $this->write(isset($options['id']) ? sprintf("%s\n%s\n\n%s\n", $options['id'], str_repeat('~', strlen($options['id'])), $output) : $output);`
	`236`	`+ $this->write(isset($options['id']) ? sprintf("### %s\n\n%s\n", $options['id'], $output) : $output);`
`237`	`237`	`}`
`238`	`238`
`239`	`239`	`/**`
`@@ -244,7 +244,7 @@ protected function describeContainerAlias(Alias $alias, array $options = array()`
`244`	`244`	$output = '- Service: `'.$alias.'`'
`245`	`245`	`."\n".'- Public: '.($alias->isPublic() ? 'yes' : 'no');`
`246`	`246`
`247`		`- $this->write(isset($options['id']) ? sprintf("%s\n%s\n\n%s\n", $options['id'], str_repeat('~', strlen($options['id'])), $output) : $output);`
	`247`	`+ $this->write(isset($options['id']) ? sprintf("### %s\n\n%s\n", $options['id'], $output) : $output);`
`248`	`248`	`}`
`249`	`249`
`250`	`250`	`/**`