Skip to content
This repository has been archived by the owner on Sep 27, 2021. It is now read-only.

votca_help2doc queries #348

Closed
junghans opened this issue Feb 8, 2021 · 3 comments · Fixed by #350
Closed

votca_help2doc queries #348

junghans opened this issue Feb 8, 2021 · 3 comments · Fixed by #350

Comments

@junghans
Copy link
Member

junghans commented Feb 8, 2021

Could we change the syntax of the Usage: line, e.g. https://www.votca.org/csg/reference.html#id31, so that is looks the same as the other two line, i.e. bold face the first word and remove Usage: as the beginning.

@junghans
Copy link
Member Author

junghans commented Feb 8, 2021

Used external packages, e.g. https://www.votca.org/csg/reference.html#id70, should go under a separate section I guess, so in the description.

@junghans
Copy link
Member Author

junghans commented Feb 8, 2021

Listing in function_common, see https://www.votca.org/csg/reference.html#id106, is still not working.

felipeZ added a commit that referenced this issue Feb 9, 2021
felipeZ added a commit that referenced this issue Feb 9, 2021
felipeZ added a commit that referenced this issue Feb 10, 2021
@felipeZ
Copy link
Member

felipeZ commented Feb 10, 2021

Listing in function_common, see https://www.votca.org/csg/reference.html#id106, is still not working.

@junghans this error is easier to solve by directly adding a new line at the end of the description here:

  cat <<EOF                                                                                                                            
${0##*/}, version %version%                                                                                                            
                                                                                                                                       
This file defines some commonly used functions:  # here                                                                                        
EOF

Just need to add a new line like:

  cat <<EOF                                                                                                                            
${0##*/}, version %version%                                                                                                            
                                                                                                                                       
This file defines some commonly used functions:  # here                                                                                        

EOF

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants