Skip to content

Commit

Permalink
Merge pull request #7 from lilyclemson/update
Browse files Browse the repository at this point in the history 
update to latest version v1.0.0

Reviewed-by: Gavin Halliday <ghalliday@hpccsystems.com>
Merged-by: Gavin Halliday <ghalliday@hpccsystems.com>
  • Loading branch information
@ghalliday
ghalliday authored Feb 2, 2024
2 parents 0b2b10c + 5d3f830 commit 3433ba2
Show file tree
Hide file tree
Showing 1,379 changed files with 471,035 additions and 12 deletions.
11 changes: 6 additions & 5 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
*.pyc
eclcc.log
*.py~
.project

# OS generated files #
######################
Expand All @@ -12,5 +9,9 @@ eclcc.log
.Trashes
ehthumbs.db
Thumbs.db


.vscode
build/*
ecldoc.egg-info
ecldoc-**.tar.gz
dist/
textput.log
140 changes: 140 additions & 0 deletions CodingPractices.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
============================
Recommended Coding Practices
============================

This document recommends certain practices for developing code documentation
so that ECLdoc can rendered it as a professional looking document, and so that
the resulting documentation is largely consistent from project to project.

Use of HTML tags:

ECLdoc ignores the line formatting of documentation strings and treats end-of-line
as a space. Comments that are formatted as multiple lines with bullet-lists or
other structure will be rendered as a run-on paragraph, and may be difficult to
follow without adding additional markup to improve readability.

For example, the following comment section:

/**
* This is the warp drive implementation module
* It serves three purposes:
* - The first purpose
* - The second purpose
* - The third purpose
**/
This would be rendered by ECLdoc as:

This is the warp drive implementation module It serves three purposes: - The
first purpose - The second purpose - The third purpose

ECLdoc supports certain html formatting tags that allow this to be fixed:
- <ul>, <li>, </li>, </ul> allow creation of lists and list items
- <pre>, </pre> (i.e. preformatted) retain the structure and enclose
the structure in a gray bounding box
- <p> (i.e. new paragraph) causes the following text to be started on
a new line.
- <b>,</b> (i.e. bold)

The list tags (<ul>, <li>) should be used to format bullet lists and the paragraph
tag (<p>) should be used whenever a sentence should be started as a new line. We
reformat the above comment as follows:

/**
* This is the warp drive implementation module.
* <p>It serves three purposes:<ul>
* <li>The first purpose.</li>
* <li>The second purpose.</li>
* <li>The third purpose.</li></ul>
**/
Note several things here:
- No bullet characters are used. The <li> will cause the appropriate character
to be inserted.
- Each sentence and bullet item is terminated with a period (.). This is good
practice to avoid inconsistent punctuation in bullet lists, which sometimes
contain multiple sentences within a list item. If it is certain that none of
the list items will contain multiple sentences, then it is okay to avoid the
period at the end of list items.

The new documentation string will be rendered as:

This is the warp drive implementation module.
It serves three purposes:
o The first purpose.
o The second purpose.
o The third purpose.

Use of documentation tags

Certain aspects of the code documentation are specially rendered as separate
sections of the documentation. These include:
- @param -- Parameter definitions.
- @return -- Return definitions.
- @field -- Field definitions.
- @value -- Value definitions e.g. for enumerations.
- @see -- References to other files or links.

These tags should always be used to describe the signature of the each ECL
attribute. For example:

/**
* Compute a logarithm of any base.
* @param val The input value. This must be a positive
* real number.
* @param base The base of the logarithm. This must be a
* positive real number greater than one.
* @return A real number representing log(base)(val).
* @see http://math.ucsd.edu/calculating-logs-of-arbitrary-bases.pdf
**/
/**
* Primary record structure for my process.
* @field recordId The id of this record. This must be unique within
* A dataset.
* @field state The state of current primary residence.
...
**/
Other things to consider

Do not put a title or the name of the attribute into the documentation string.
The ECLdoc rendering includes the name of the attribute as well as its type.
The title or function name appear to be redundant after rendering.

For example:

/**
* GenLog
*
* Compute a logarithm of any base.
...
**/
This might be rendered as:

GenLog: Genlog Compute a logarithm of any base.

The first sentence of the documentation string should be immediately descriptive
of the attribute as it is used to create a summary of the attribute when the
details of that attribute are collapsed.

For example:

/**
* Use this as an alternative to existing ECL log functions when needing
* a base other than e or 10.
* Calculates a logarithm of any base.
...
**/
The summary string might read: "Use this as an alternative to existing ECL", which
does not provide much insight into the purpose or function.

It is better to state the major function in the first few words, using the present
tense. For example: "Compute a logarithm of any base".





Binary file modified Documentation.odt
View file
Binary file not shown.
201 changes: 201 additions & 0 deletions LICENSE
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
2 changes: 1 addition & 1 deletion Makefile
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
install :
pip3 install ./src
pip3 install .

uninstall :
pip3 uninstall -y ecldoc
21 changes: 21 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# ECLDoc

Ecldoc is a tool for generating API Documentation for ECL Project based on their docstrings. The executable ecldoc is the main program that parses the sources and generate Documentation.

## Requirements

- You need Python3
- Install pip3, setuptools
- Install texlive-full
- Install make

## Get started

If you are on Windows, please make sure to follow [windows guidelines](docs/windows.md#windows) too.

- To install, ``cd`` to `ECLDocGenerator/`.
- Run : ``sudo make install`` (if root permissions)
- Else Run : ``make install`` (add default pip3 installation directory to $PATH env variable - most commonly $HOME/.local/bin)

Or you can install through pip:
- pip3 install ecldoc
Loading

0 comments on commit 3433ba2

Please sign in to comment.