[
https://issues.apache.org/jira/browse/YETUS-439?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15397680#comment-15397680
]
Kengo Seki commented on YETUS-439:
----------------------------------
No, I expect they are sorted in alphabetical order, as well as other sections
in shelldoc.
For now, if some function doesn't have {{@replaceable}} and another has
{{@replaceable no}} and other annotations are all the same between them, their
order is undefined because {{ShellFunction.\_\_cmp\_\_()}} always returns 1
regardless of their function names.
> "Public/Stable/Not Replaceable" plugin functions are not properly ordered in
> generated shelldocs
> ------------------------------------------------------------------------------------------------
>
> Key: YETUS-439
> URL: https://issues.apache.org/jira/browse/YETUS-439
> Project: Yetus
> Issue Type: Bug
> Components: ShellDocs, website and documentation
> Reporter: Kengo Seki
> Priority: Minor
>
> {code}
> sekikn@ubuntu-trusty:~/yetus$ shelldocs/shelldocs.py --output /tmp/foo
> --input precommit/test-patch.d/jira.sh --input precommit/test-patch.d/java.sh
> --input precommit/test-patch.d/github.sh --input
> precommit/test-patch.d/bugzilla.sh
> sekikn@ubuntu-trusty:~/yetus$ cat /tmp/foo
>
> (snip)
> * Public/Stable/Not Replaceable
> * [jira\_write\_comment](#jira_write_comment)
> * [javac\_precheck](#javac_precheck)
> * [bugzilla\_write\_comment](#bugzilla_write_comment)
> * [github\_write\_comment](#github_write_comment)
> (snip)
> {code}
> Adding {{## @replaceable no}} to *_write_comment functions fixes it, but
> shelldocs.py itself should handle "No" and None properly.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
