[jira] [Comment Edited] (YETUS-415) shelldocs ability to ignore a file

["Ajay Yadava (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/YETUS-415?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15386290#comment-15386290 ] 

Ajay Yadava edited comment on YETUS-415 at 7/20/16 5:53 PM:
------------------------------------------------------------

Ah, I see what you mean. Sorry I didn't know that! I just used it this way instead of *anywhere* in the file because

1. It will potentially save parsing a large file
2. It might be confusing for someone else to see a large file getting ignored because of a comment embedded "anywhere" in between.


"Either Last line or first two lines" approach will avoid (2) Let me know how you feel about the following options and I will be happy to make the changes

1. Current way (1st or first after shebang)
2. Either last line or above case
3. Anywhere in the file

Thanks for the review!


was (Author: ajayyadava):
Ah, I see what you mean. Sorry I didn't know that! I just used it this way instead of *anywhere* in the file because

1. It will potentially save parsing a large file
2. It might be confusing for someone else to see a large file getting ignored because of a comment embedded ""in between.


"Either Last line or first two lines" approach will avoid (2) Let me know how you feel about the following options and I will be happy to make the changes

1. Current way (1st or first after shebang)
2. Either last line or above case
3. Anywhere in the file

Thanks for the review!

> shelldocs ability to ignore a file
> ----------------------------------
>
>                 Key: YETUS-415
>                 URL: https://issues.apache.org/jira/browse/YETUS-415
>             Project: Yetus
>          Issue Type: New Feature
>          Components: ShellDocs
>            Reporter: Allen Wittenauer
>            Assignee: Ajay Yadava
>             Fix For: 0.4.0
>
>         Attachments: YETUS-415.00.patch
>
>
> it would be nice if there was a way to tell shelldocs to ignore a file during the parse phase via a comment in the file.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)