Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor documentation and identifiers' names #4

Open
kolayne opened this issue Jul 11, 2020 · 2 comments
Open

Refactor documentation and identifiers' names #4

kolayne opened this issue Jul 11, 2020 · 2 comments
Assignees
@pavtiger
Labels
documentation Improvements or additions to documentation refactoring

Comments

@kolayne
Copy link
Member

kolayne commented Jul 11, 2020

Reread the whole code and bring both identifiers' names and documentation to a single style. Also, fix typos, language mistakes. It would be perfect to create a Markdown document describing the rules of our documenting style
@kolayne
Copy link
Member Author

kolayne commented Jul 11, 2020 •
edited
Loading

We are not yet ready to start, but I guess, we are ready to when #2 is merged

@kolayne kolayne added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 11, 2020
This was referenced Sep 12, 2020
Merged
Merged
kolayne added a commit that referenced this issue Oct 24, 2020
@kolayne
Rearranged code in src across subdirectories
e381bc9 
New includes appearance (with paths) may help when working on #4 and/or #13
@kolayne
Copy link
Member Author

kolayne commented Nov 15, 2020

TODO: add <br>s in the documentation where line breaks are expected because Doxygen ignores usual line breaks

@kolayne kolayne added refactoring and removed enhancement New feature or request labels Nov 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pavtiger pavtiger

Labels
documentation Improvements or additions to documentation refactoring
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kolayne @pavtiger