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.

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

Yard #657

Merged
merged 3 commits into from Sep 2, 2011

Conversation

Projects
None yet
3 participants
@postmodern
Contributor

postmodern commented Sep 2, 2011

  • Fixed .document files so YARD does not try to parse LICENSE files.
  • Added YARD tags.
  • Kept documentation within 80 columns
@nesquena

This comment has been minimized.

Show comment
Hide comment
@nesquena

nesquena Sep 2, 2011

Member

Thanks a lot for helping out with this!

Member

nesquena commented Sep 2, 2011

Thanks a lot for helping out with this!

nesquena added a commit that referenced this pull request Sep 2, 2011

@nesquena nesquena merged commit 7fd1036 into padrino:master Sep 2, 2011

@DAddYE

This comment has been minimized.

Show comment
Hide comment
@DAddYE

DAddYE Sep 2, 2011

Member

@postmodern, thanks so so much impressive work!

Only two question:

  • As first line of comment can we keep ## ?
  • Should we document external deps like HttpRouter ?

@nesquena?

Thanks Man!!! Very nice work!

Member

DAddYE commented on 9ae898f Sep 2, 2011

@postmodern, thanks so so much impressive work!

Only two question:

  • As first line of comment can we keep ## ?
  • Should we document external deps like HttpRouter ?

@nesquena?

Thanks Man!!! Very nice work!

This comment has been minimized.

Show comment
Hide comment
@postmodern

postmodern Sep 2, 2011

Contributor

## is ignored by YARD so it's alright, although I don't use that syntax. I assume it's used for grepping for the beginning of comments?

I would document everything, and use @api private|semipublic|public tags where necessary.

Contributor

postmodern replied Sep 2, 2011

## is ignored by YARD so it's alright, although I don't use that syntax. I assume it's used for grepping for the beginning of comments?

I would document everything, and use @api private|semipublic|public tags where necessary.

This comment has been minimized.

Show comment
Hide comment
@DAddYE

DAddYE Sep 2, 2011

Member

Yep ## it's only for esthetic reason and yep because help a bit to understand where a comment start.

Im right with to document every thing and add the appropriate tag!

Thanks

Member

DAddYE replied Sep 2, 2011

Yep ## it's only for esthetic reason and yep because help a bit to understand where a comment start.

Im right with to document every thing and add the appropriate tag!

Thanks

This comment has been minimized.

Show comment
Hide comment
@nesquena

nesquena Sep 2, 2011

Member

Yeah thanks @postmodern for getting the ball rolling. Will try and tackle an entire gem soon (probably helpers)

Member

nesquena replied Sep 2, 2011

Yeah thanks @postmodern for getting the ball rolling. Will try and tackle an entire gem soon (probably helpers)

This comment has been minimized.

Show comment
Hide comment
@postmodern

postmodern Sep 2, 2011

Contributor

Almost forgot, just added the yard rake task and .yardopts files. Pull in 6293e995a89beb89ba67136a77eab3e90fd08782.

Contributor

postmodern replied Sep 2, 2011

Almost forgot, just added the yard rake task and .yardopts files. Pull in 6293e995a89beb89ba67136a77eab3e90fd08782.

This comment has been minimized.

Show comment
Hide comment
@nesquena

nesquena Sep 2, 2011

Member

Thanks, committed here: 2fd8ca7

Member

nesquena replied Sep 2, 2011

Thanks, committed here: 2fd8ca7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment