Skip to content

Improve the documentation of JS8Submode.hpp.#2

Merged
Chris-AC9KH merged 3 commits into
JS8Call-improved:masterfrom
aknrdureegaesr:submode_streamline
Oct 23, 2025
Merged

Improve the documentation of JS8Submode.hpp.#2
Chris-AC9KH merged 3 commits into
JS8Call-improved:masterfrom
aknrdureegaesr:submode_streamline

Conversation

@aknrdureegaesr

Copy link
Copy Markdown
Collaborator

The present JS8Submode.hpp makes it unnecessarily hard to understand what is going on.

  • The same thing is sometimes called "cycle" and sometimes "period".
  • The same thing is sometimes called "frame" and somtimes "sample".
  • The whole interface is insufficiently documented.

The net result is a hurdle for (new) developers to join the project and contribute.

This PR improves the situation.

@Chris-AC9KH

Copy link
Copy Markdown
Collaborator

@bazineta Allan, when you get a chance could you glance thru this? It looks ok to me.

@aknrdureegaesr

Copy link
Copy Markdown
Collaborator Author

It looks ok to me.

Thanks, Chris 🌹!

Just a random remark with no direct consequences: We have not decided on the merge rules yet. But if they were in place as suggested (and if we understand "looks ok to me" as equivalent to "looks good to me"), this would mean approval count is now 1 and the PR could be merged starting Tuesday, 2025-10-27 21:18 UTC , even if Allan does not react by then.

@bazineta

Copy link
Copy Markdown
Contributor

This looks excellent. This particular TU originated as an extraction of these concepts from being littered everywhere in the 2.2.0 codebase and landing them in one place and one place only for 2.3.0, so yes, no argument that it could have been done better; I was at the time trying not to break anything in the process, and so didn't give much thought to the naming.

@wmiler wmiler added the ready Ready to merge label Oct 23, 2025
@Chris-AC9KH Chris-AC9KH merged commit 7e21d39 into JS8Call-improved:master Oct 23, 2025
@Chris-AC9KH

Copy link
Copy Markdown
Collaborator

Merged. Thanks!

wmiler added a commit that referenced this pull request Oct 25, 2025
Add Doxygen output directory to .gitignore
Chris-AC9KH added a commit to Chris-AC9KH/JS8Call-improved that referenced this pull request Jun 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready Ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants