Open issues with manual

michael-hartmann / caps

The Casimir Effect in the plane-sphere geometry.

GNU General Public License v2.0

4 stars 1 forks source link

Open issues with manual #122

Closed gertingold closed 4 years ago

gertingold commented 4 years ago

Rereading the manual, I found the following open issues which should be addressed in one way or the other before submission:

[X] The manual contains different version numbers (0.4.2 on the title page and 0.4.3 in the listings). Before fixing this, we should decide whether in view of the submission, we want to go to 1.0. (resolved by #123 and #126, sticking to 0.4.3)
[x] Is the reference to Emig et al. in the context of plane-cylinder really the appropriate one? (fixed by #124)
[X] Is it ok to leave local computer information in the manual? (addressed in #127)
[X] The syntax highlighting in some cases seems a bit odd. For example, on page 5, the argument of -n is highlighted but not the other numerical parameters. Overall, the highlighting seems pretty inconsistent and in most cases rather useless. Should we get rid of the highlighting or rather keep it? (fixed by #125)

I can do the changes once it is decided what to change or keep.

michael-hartmann commented 4 years ago

Thank you very much for your suggestions!

Version numbers

PR #123 changes the version number in one listing from 0.4.3-dev to 0.4.3. I cannot find a version 0.4.2 in the manual.

Emig reference

The Emig reference seems to be not the one I wanted to choose. The PRL from 2006 seems to be the appropriate reference. Good catch! See PR #124.

Local computer information

I don't see a problem with that. Maybe, the local computer administrator has a different opinion on that. If you think we should change the listings and remove the hostname, I am happy to do so. Do you have a suggestion for a generic hostname?

Syntax hightling

The syntax highligting is indeed odd. Should we turn it off?

gertingold commented 4 years ago

Version numbers

The version number on the title page is defined in conf.py. I can easily change this but the question is whether we want to stick with 0.4.3 for submission.

Local computer information

I will ask our administrator's opinion. Most of the information given like your userid is outdated anyway.

Syntax highlighting

Probably we should switch off highlighting. As far as I can see, there is no listing where the highlighting adds any value.

gertingold commented 4 years ago

Sorry, I did not mean to close the issue...

michael-hartmann commented 4 years ago

The version number issue is finally solved by #126. I'd like to stick to 0.4.3 for the release.

gertingold commented 4 years ago

Ok. Then I propose that tomorrow I try to get an opinion on local computer information in the manual. Then, we can regenerate the manual and are ready for submission as far as I can tell.

michael-hartmann commented 4 years ago

Perfect! :-)

gertingold commented 4 years ago

@bs89 has no strong opinion about local computer information so tomorrow I am going to ask the big boss...

gertingold commented 4 years ago

With all points completed, I guess we are ready for submission. What do you think, @michael-hartmann?