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.

Sign up for GitHub

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

Jump to bottom

Template for Examples documentation #160

Merged
merged 1 commit into from
Jan 27, 2014
Merged

Template for Examples documentation #160

merged 1 commit into from
Jan 27, 2014

Conversation

ax3l
Copy link
Member

@ax3l ax3l commented Jan 27, 2014

Since some guys can not wait any longer (I am just kidding), I will upload the YAML template of #7 already.

@ghost ghost assigned PrometheusPi Jan 27, 2014
@ax3l ax3l mentioned this pull request Jan 27, 2014
Closed
9 tasks
@ax3l
Copy link
Member Author

ax3l commented Jan 27, 2014

Just to give you a description.
As posted in the Wikipedia entry for YAML, the white-spaces matter.
Please use the same style for intends as the template in the KHI example.

You can add your own tests in the section

test:
  - myTestName:

but again, stick to the used keywords and spaces!

Every non-zero result in pre-run, post-run and the .cfg's run itself will be interpreted as failed test, so use that as an option to indicate an error/failure of your test please.

@ax3l
Draft for example documentation
836479a 
- template done
- YAML style
- limits defined
PrometheusPi added a commit that referenced this pull request Jan 27, 2014
@PrometheusPi
Merge pull request #160 from ax3l/topic-docExampleTemplate
0f8c429 
Template for Examples documentation
Finally - the template is ready.
@PrometheusPi PrometheusPi merged commit 0f8c429 into ComputationalRadiationPhysics:dev Jan 27, 2014
@ax3l ax3l deleted the topic-docExampleTemplate branch January 27, 2014 16:36
@PrometheusPi
Copy link
Member

@ax3l Is the colon and the spacing in references/author correct?
Or does spacing not matter for the references?

@ax3l
Copy link
Member Author

ax3l commented Jan 27, 2014

What lines do you refer to?

PrometheusPi
PrometheusPi reviewed Jan 27, 2014
View reviewed changes
examples/KelvinHelmholtz/documentation.yml

references:
- Alves12: &Alves12
author ...
Copy link
Member

Choose a reason for hiding this comment

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

no colon, no spacing as below

Copy link
Member Author

Choose a reason for hiding this comment

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

yep, missing here.

@PrometheusPi
Copy link
Member

Does it matter? Or is it just a style issue we can fix later on?

@ax3l
Copy link
Member Author

ax3l commented Jan 27, 2014

Matters, you can just fix that little error in my example when you push your documentation.

@PrometheusPi
Copy link
Member

OK, I will do this.

@ax3l
Copy link
Member Author

ax3l commented Jan 27, 2014

Thx, sorry for the typo.

@PrometheusPi
Copy link
Member

add correction in #162

psychocoderHPC pushed a commit to psychocoderHPC/picongpu that referenced this pull request Apr 1, 2020
@psychocoderHPC
Squashed 'thirdParty/cupla/' changes from ed00837ef6..0614c10404
78b7c44 
0614c10404 Merge commit '69ac376e59bca4aed3556f94a6c844195ee39307' into spec-cupla-alpaka0.5.0dev
69ac376e59 Squashed 'alpaka/' changes from c2d14d09ea..cb87c59bb4
dbc0f649b2 Merge pull request ComputationalRadiationPhysics#160 from psychocoderHPC/topic-updateAlpakaTo0.5.0dev
13b737ba6c Squashed 'alpaka/' changes from ab0b8a460..c2d14d09e
b31fc4ea33 Merge commit '13b737ba6cd38400636d6a6a52dee81b21a7412c' into topic-updateAlpakaTo0.5.0dev
09d5daf1ff update travis tests
582f8ca10e update CMake requirements
59fba492fa include changes needed to use alpaka 0.5.0

git-subtree-dir: thirdParty/cupla
git-subtree-split: 0614c10404b057d7e777bf17a2078981bc87b43b
psychocoderHPC pushed a commit to psychocoderHPC/picongpu that referenced this pull request Apr 16, 2020
@psychocoderHPC
Squashed 'thirdParty/cupla/' changes from ed00837ef6..123cf3c952
8810cfc 
123cf3c952 Merge commit 'a1601e35c146c09d339239f076e477680982c2f7' into spec-cupla-alpaka0.5.0dev
a1601e35c1 Squashed 'alpaka/' changes from c2d14d09ea..b52eefa232
047884171f Merge pull request ComputationalRadiationPhysics#167 from psychocoderHPC/fix-ambiguousNamespace
a63eeb52e1 Merge pull request ComputationalRadiationPhysics#166 from psychocoderHPC/topic-moveMathDir
8564d2dc4f fix ambiguous namespace `device`
a0302ff66c move `cupla/math` to `cupla/device/math`
d6310a037e Merge pull request ComputationalRadiationPhysics#165 from psychocoderHPC/topic-updateGithubLinks2
e7f9261bf7 update cupla github links
f4dba001d4 Merge pull request ComputationalRadiationPhysics#162 from psychocoderHPC/topic-cuplaAccMathFunctions
bbbc0b0266 `BlackScholes` use cupla math functions
efa8d61037 on device math functions
dbc0f649b2 Merge pull request ComputationalRadiationPhysics#160 from psychocoderHPC/topic-updateAlpakaTo0.5.0dev
13b737ba6c Squashed 'alpaka/' changes from ab0b8a460..c2d14d09e
b31fc4ea33 Merge commit '13b737ba6cd38400636d6a6a52dee81b21a7412c' into topic-updateAlpakaTo0.5.0dev
09d5daf1ff update travis tests
582f8ca10e update CMake requirements
59fba492fa include changes needed to use alpaka 0.5.0

git-subtree-dir: thirdParty/cupla
git-subtree-split: 123cf3c952f4b5c4d2200fb9f2bb09bb84019614
psychocoderHPC pushed a commit to psychocoderHPC/picongpu that referenced this pull request Apr 24, 2020
@psychocoderHPC
Squashed 'thirdParty/cupla/' changes from ed00837ef6..d6310a037e
1e47478 
d6310a037e Merge pull request ComputationalRadiationPhysics#165 from psychocoderHPC/topic-updateGithubLinks2
e7f9261bf7 update cupla github links
f4dba001d4 Merge pull request ComputationalRadiationPhysics#162 from psychocoderHPC/topic-cuplaAccMathFunctions
bbbc0b0266 `BlackScholes` use cupla math functions
efa8d61037 on device math functions
dbc0f649b2 Merge pull request ComputationalRadiationPhysics#160 from psychocoderHPC/topic-updateAlpakaTo0.5.0dev
b31fc4ea33 Merge commit '13b737ba6cd38400636d6a6a52dee81b21a7412c' into topic-updateAlpakaTo0.5.0dev
13b737ba6c Squashed 'alpaka/' changes from ab0b8a460..c2d14d09e
09d5daf1ff update travis tests
582f8ca10e update CMake requirements
59fba492fa include changes needed to use alpaka 0.5.0

git-subtree-dir: thirdParty/cupla
git-subtree-split: d6310a037e7207325e951a2ef5712268804a5b91
psychocoderHPC pushed a commit to psychocoderHPC/picongpu that referenced this pull request May 18, 2020
@psychocoderHPC
Squashed 'thirdParty/cupla/' changes from ed00837ef6..b72833cbf0
1bce205 
b72833cbf0 Merge pull request ComputationalRadiationPhysics#169 from psychocoderHPC/topic-moreMathFunctions
b9944dc139 math functions: `erf` and `pow`
047884171f Merge pull request ComputationalRadiationPhysics#167 from psychocoderHPC/fix-ambiguousNamespace
a63eeb52e1 Merge pull request ComputationalRadiationPhysics#166 from psychocoderHPC/topic-moveMathDir
8564d2dc4f fix ambiguous namespace `device`
a0302ff66c move `cupla/math` to `cupla/device/math`
d6310a037e Merge pull request ComputationalRadiationPhysics#165 from psychocoderHPC/topic-updateGithubLinks2
e7f9261bf7 update cupla github links
f4dba001d4 Merge pull request ComputationalRadiationPhysics#162 from psychocoderHPC/topic-cuplaAccMathFunctions
bbbc0b0266 `BlackScholes` use cupla math functions
efa8d61037 on device math functions
dbc0f649b2 Merge pull request ComputationalRadiationPhysics#160 from psychocoderHPC/topic-updateAlpakaTo0.5.0dev
b31fc4ea33 Merge commit '13b737ba6cd38400636d6a6a52dee81b21a7412c' into topic-updateAlpakaTo0.5.0dev
13b737ba6c Squashed 'alpaka/' changes from ab0b8a460..c2d14d09e
09d5daf1ff update travis tests
582f8ca10e update CMake requirements
59fba492fa include changes needed to use alpaka 0.5.0

git-subtree-dir: thirdParty/cupla
git-subtree-split: b72833cbf0844664b26bbf553289356cfa03c18a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@PrometheusPi PrometheusPi

Labels
documentation regarding documentation or wiki discussions
Projects
None yet
Milestone
0.2.0: Open Beta
Development

Successfully merging this pull request may close these issues.
2 participants
@ax3l @PrometheusPi