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

Rose user guide rose stem #2177

Conversation

oliver-sanders
Copy link
Member

@oliver-sanders oliver-sanders commented Apr 25, 2018

Built on #2170, merge after

Migrate the rose stem user guide into the new rose documentation. Some documentation moved into the codebase, otherwise a direct translation.

@oliver-sanders oliver-sanders added this to the next-release milestone Apr 25, 2018
@oliver-sanders oliver-sanders self-assigned this Apr 25, 2018
@oliver-sanders oliver-sanders changed the base branch from rose-user-guide-overhaul to master April 25, 2018 15:15
@oliver-sanders oliver-sanders changed the base branch from master to rose-user-guide-overhaul April 25, 2018 15:15
@stevewardle
Copy link
Contributor

It all looks fine to me, with the exception of the docstring at the top of grepper.py... Although perhaps I'm just unfamiliar with the markdown syntax... it says rose_ana[ana:ANALYSIS_CLASS]' - I assume that translates to the [rose_ana] section of a user rose.conf file? The example of using this in the rest of the documentation is correct I just can't see how this comment relates to it... Likewise the rest of that sentence/paragraph reads a little oddly... the 3 places it can go are:

  • In the [rose_ana] section of the site configuration
  • In the [rose_ana] section of a user's personal rose.conf
  • In the [ana:config] section of a rose_ana app

@oliver-sanders
Copy link
Member Author

Hows this?

I assume that translates to the [rose_ana] section of a user rose.conf file?

It translates to the [rose-ana] section in the rose.conf file, is this meant to be [rose_ana]?

@stevewardle
Copy link
Contributor

No you're right - it's [rose-ana]... I can see the changes but it seems to leave out the [ana:config] section of the app?

@oliver-sanders
Copy link
Member Author

Is [ana:config] different to [ana:ANALYSIS_CLASS]?

@stevewardle
Copy link
Contributor

stevewardle commented Apr 27, 2018

I would say so... the sections in the rose_ana files are based on the name of the class they are meant to call (I guess that might be where "Analysis Class" in that comes from) but the section that can contain the "global" settings must be called [ana:config]

@stevewardle stevewardle merged commit 08e0fc2 into metomi:rose-user-guide-overhaul Apr 27, 2018
@oliver-sanders oliver-sanders deleted the rose-user-guide-rose-stem branch May 18, 2018 09:19
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.

2 participants