Skip to content

Conversation

@munslowa
Copy link
Contributor

@munslowa munslowa commented Mar 9, 2013

This pull request addresses #385

Copy link
Member

Choose a reason for hiding this comment

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

For an .rst literal block, you need to indent it by at least one character.

My preference is v1.2 rather than V1.2.

@bjlittle
Copy link
Member

bjlittle commented Mar 9, 2013

You editor seem to have added tab characters to the content of each section, was that intentional? As it's shifting all the content to the right, which is not necessary.

Otherwise 👍 thanks @munslowa

@munslowa
Copy link
Contributor Author

Tabs not intentional. Using gedit. I check its preferences.

@munslowa
Copy link
Contributor Author

I cannot see any tabs either with vi (set list) or cat -T or kate.

@cpelley
Copy link

cpelley commented Mar 11, 2013

Hi @munslowa what is wrong with the @Manual type? This is technical documentation so would fit neatly under that type. This does not fit under the @Article type as it is not published under a journal so you will not be able to supply the required fields.

@article 
    An article from a magazine or a journal.

        Required fields: author, title, journal, year.
        Optional fields: volume, number, pages, month, note.

@manual
    Technical manual

        Required fields: title.
        Optional fields: author, organization, address, edition, month, year, note.

see: http://en.wikibooks.org/wiki/LaTeX/Bibliography_Management

@ghost ghost assigned bjlittle Mar 12, 2013
@bjlittle
Copy link
Member

Only two points and then we're good to go!

  • For the Downloaded Software and Checked out Software sections, do you think it's appropriate to have a suggested format introduction i.e.
Suggested format::

    Product-Name. Version. Release-Date. Publisher. Location. DOI/URL. Download-Date.

For example::

    Iris. v1.2. 28-Feb-2013. Met Office. UK. https://github.com/SciTools/iris/archive/v1.2.0.tar.gz 01-03-2013

Note I've also moved away from pure camel case for the tokens within the suggested format. I think it's more readable. Also I'm suggesting v1.2 rather than V1.2.

  • You need to squash all your lovely commits into one. Glad to assist if you're unsure how to do this in git.

esc24 added a commit that referenced this pull request Mar 12, 2013
Iris citation added into user guide
@esc24 esc24 merged commit 40bb730 into SciTools:master Mar 12, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants