Skip to content

Remove skeleton comments #309

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

Merged
kamil-tekiela merged 2 commits into from
Jun 27, 2026
+1 −18
Merged

Remove skeleton comments #309

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b972d4
[skip-revcheck] align actual skeleton to decisions taken in [skip-rev…
NickSdot Jun 26, 2026
7f75e42
[skip-revcheck] improved wording
NickSdot Jun 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions skeletons/book.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,12 @@
<title>Long title of extension</title>
<titleabbrev>Extname</titleabbrev>

<!-- {{{ preface -->
<preface xml:id="intro.extname">
&reftitle.intro;
<simpara>
Extension introduction.
</simpara>
</preface>
<!-- }}} -->

&reference.extname.setup;
&reference.extname.constants;
Expand Down
4 changes: 0 additions & 4 deletions skeletons/classname.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,16 @@

<partintro>

<!-- {{{ ClassName intro -->
<section xml:id="classname.intro">
&reftitle.intro;
<simpara>
Description of the class.
</simpara>
</section>
<!-- }}} -->

<section xml:id="classname.synopsis">
&reftitle.classsynopsis;

<!-- {{{ Synopsis -->
<classsynopsis class="class">
<ooclass>
<classname>ClassName</classname>
Expand Down Expand Up @@ -90,7 +87,6 @@
<xi:fallback/>
</xi:include>
</classsynopsis>
<!-- }}} -->

</section>

Expand Down
3 changes: 0 additions & 3 deletions skeletons/exceptionname.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,16 @@

<partintro>

<!-- {{{ ExceptionName intro -->
<section xml:id="exceptionname.intro">
&reftitle.intro;
<simpara>
Description of the exception.
</simpara>
</section>
<!-- }}} -->

<section xml:id="exceptionname.synopsis">
&reftitle.classsynopsis;

<!-- {{{ Synopsis -->
<classsynopsis class="class">
<ooclass>
<classname>ExceptionName</classname>
Expand Down
2 changes: 1 addition & 1 deletion skeletons/method.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Procedural synopsis goes after OOP synopsis.
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding standards';
echo 'Use the latest PHP-FIG PER Coding style for PHP code examples: https://www.php-fig.org/per/coding-style/';
}
if ($thereisoutput === 'and it is multiple lines') {
echo 'Use a screen like we did below';
Expand Down
8 changes: 0 additions & 8 deletions skeletons/setup.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,27 @@
&reftitle.setup;

<!-- Remove sections which are useless -->
<!-- {{{ Requirements -->
<section xml:id="extname.requirements">
&reftitle.required;
&no.requirement;
</section>
<!-- }}} -->

<!-- {{{ Installation -->
<section xml:id="extname.installation">
&reftitle.install;
&no.install;
</section>
<!-- or &reference.extname.entities.configure; -->
<!-- }}} -->

<!-- {{{ Configuration -->
<section xml:id="extname.configuration">
&reftitle.runtime;
&no.config;
</section>
<!-- or &reference.extname.entities.ini; -->
<!-- }}} -->

<!-- {{{ Resources -->
<section xml:id="extname.resources">
&reftitle.resources;
&no.resource;
</section>
<!-- }}} -->

</chapter>
<!-- Keep this comment at the end of the file
Expand Down
Loading