Skip to content

Remove source comments and documentation. #7

@droidengineer

Description

@droidengineer

QUESTION

Is it necessary to have so much text commentary and doc support?

BACKGROUND

Since the project started off (and ostensibly still is) as a learning adventure (and need) it is heavily commented in many areas. A large part of it went in originally to keep a reference of the EGT binary format and content.

ARGUMENTS

KEEP

Deep commentary, especially of an expository or abstruse requirements, may be of benefit to others. Leaving the comments in could help someone else to find a better solution and publish it back.

REMOVE

There are arguably many comment groups with background/meta info that doesn't provide much value for the developer. Re: the documentation markup: is there going to be documentation using this?

CONCLUSION

Solutions?

  1. Remove superfluous comments and doc markup.
  2. Manage a separate branch with heavily annotated code

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationquestionFurther information is requested

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions