Replace PR #48: FORD commits only #49
Conversation
Comments that appear just after the beginning of a module or procedure now start with a double bang (!!) instead of a single bang (!). Comments elsewhere are unchanged.
|
@milancurcic this PR is now ready to merge. The documentation now contains lots of text from the comments in the code. See doc.tar.gz. |
milancurcic
left a comment
milancurcic
left a comment
There was a problem hiding this comment.
Looks great, thanks! I renamed the FORD file to make it shorter and obvious what tool it belongs to and added a few notes to the README.
Please merge when ready (I think you have sufficient permissions to do that, let me know if not).
A note about expanding the docstrings in the code. I'm preparing a large refactor coming in a week or two which will allow a network to use arbitrary layers (need dense, conv2d, maxpool, input, and flatten layers), which will be a pretty much a complete re-write of the framework, so any additional docstrings at this time would not have a long life. But the new code will maintain the FORD-friendly !! comments, so our FORD config will work as is. Will discuss the re-design in a separate issue.
|
@milancurcic it appears that I don't have the privileges required to merge this PR. |
|
OK, can you try now? |
|
Yes, done. Thanks! |
2 participants
As requested in an issue comment, this PR contains only commits related to adding FORD documentation. The text below is mostly copied from the now-closed PR #48, which the current PR replaces.
doc-generator.mdFORD project file that produces HTML documentation insidedoc/html/and includes the top-levelREADME.mdcontent in the landing page:doc/html/index.html.!with!!in comments only in thenf_random_modjust after the first line of the module and just after the first lines of the procedure interface bodies. Doing so triggers for to include the corresponding comments in the generated documentation.doc/subdirectory to the.gitignorefile.If this PR gets merged, then executing
will produce an uncompressed version of doc.tar.gz.
If approved, this PR can be updated to apply similar changes to the rest of the files in
src/:mod_activation.f90
mod_mnist.f90
mod_parallel.f90
mod_layer.f90
mod_network.f90