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

Revise cmake_options.rst #2067

Closed
heplesser opened this issue Jun 9, 2021 · 1 comment · Fixed by #2230
Closed

Revise cmake_options.rst #2067

heplesser opened this issue Jun 9, 2021 · 1 comment · Fixed by #2230
Assignees
@stinebuu
Labels
good first issue Good for newcomers I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority stale Automatic marker for inactivity, please have another look here T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Documentation
Milestone
NEST 3.2

Comments

@heplesser
Copy link
Contributor

CMake options are not presented well in cmake_options.rst. Instead of blocks of code including the descriptions of the options in pre-formatted form, we should create a table with the options preformatted in the left column and the descriptions in the right column. In this way, descriptions can also contain references to other parts of the documentation.

We should also review ordering and grouping of options, putting the most used ones forward, and possibly revise group headings.
@heplesser heplesser added S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) good first issue Good for newcomers labels Jun 9, 2021
@heplesser heplesser added this to To do in Documentation via automation Jun 9, 2021
@heplesser heplesser added this to the NEST 3.1 milestone Jun 30, 2021
@stinebuu stinebuu self-assigned this Aug 30, 2021
@heplesser heplesser modified the milestones: NEST 3.1, NEST 3.2 Sep 3, 2021
@github-actions
Copy link

github-actions bot commented Nov 2, 2021

Issue automatically marked stale!

@github-actions github-actions bot added the stale Automatic marker for inactivity, please have another look here label Nov 2, 2021
@stinebuu stinebuu mentioned this issue Dec 7, 2021
Merged
Documentation automation moved this from To do to Done Jan 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stinebuu stinebuu

Labels
good first issue Good for newcomers I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority stale Automatic marker for inactivity, please have another look here T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Documentation
  
Done
Milestone
NEST 3.2
Development

Successfully merging a pull request may close this issue.

Restructure cmake_options.rst stinebuu/nest-simulator
2 participants
@heplesser @stinebuu