Skip to content
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

included new type_uuid #64

Merged
merged 5 commits into from
Apr 27, 2015
Merged

included new type_uuid #64

merged 5 commits into from
Apr 27, 2015

Conversation

alvarosimon
Copy link
Member

UUID type is used by different Quattor components. It makes sense to include it into pan/types

@hpcugentbot
Copy link

Automatic reply from Jenkins: Can I test this?

@alvarosimon
Copy link
Member Author

@stdweird already told me that we must change the old comments code to the new documentation format, I will do that (that's the reason why I don't like to modify old code... 😄)

@jrha
Copy link
Member

jrha commented Apr 21, 2015

😀 Hey, it's just an opportunity to make things better right...?

@jrha jrha added this to the 15.4 milestone Apr 21, 2015
@alvarosimon
Copy link
Member Author

@jrha @stdweird sure! 👍 I have changed the comments to use the new pan annotations, please let me know if this is ok...


VERSION: 3.2.7, 21/08/09 22:22
AUTHOR: Martin Bock
MAINTAINER: Marco Emilio Poleggi <[email protected]>, German Cancio <[email protected]>, Michel Jouvin <[email protected]>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should these be in @maintainer{} blocks?

I'm not sure, just looking at the examples in https://quattor-pan.readthedocs.org/en/pan-10.2/pan-book/pan-book.html#annotations...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think so, I was just wondering about that as well.. I will include a @maintainer block for each one

email = [email protected]
}
@documentation{
This is 'namespaces/standard/pan/types.tpl', a pan-templates's file
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove whole block till the actual documentation (Data type ...). This is irrelevant, ancient and redundant

@stdweird
Copy link
Member

@alvarosimon no need to repeat the function or type is is annotated; that is covered by the tools that generate the docs from the annotations.
wrt the author, i'd remove it, since it's not adding much (and we don't do it anywhere else).

@jrha @jouvin do we have a good way to credit the authors?

@alvarosimon
Copy link
Member Author

@stdweird ok I will remove the unnecessary documentation blocks

@alvarosimon
Copy link
Member Author

@stdweird @jrha ok I have replaced maintainer by contributor, I think that now is more clean...

@jrha
Copy link
Member

jrha commented Apr 27, 2015

Much better.

jrha added a commit that referenced this pull request Apr 27, 2015
@jrha jrha merged commit 11ebaa7 into quattor:master Apr 27, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants