refactor(docs): rework server docs and formatting - #70
Open
brandon1024 wants to merge 1 commit into
Open
Conversation
This revision improves the formatting and wording of the documentation for server types and methods. These changes offer further elaboration on behaviours and functions, and also link to other types nicely in the (rendered) docs pages. The [ModbusServer.Stop] has been deprecated in favour of [ModbusServer.Close], thereby implementing [io.Closer]. This revision also formats the server sources with the standard formatter (gofmt), to be a bit more idiomatic.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This revision improves the formatting and wording of the documentation for server types and methods. These changes offer further elaboration on behaviours and functions, and also link to other types nicely in the (rendered) docs pages.
The
ModbusServer.Stophas been deprecated in favour ofModbusServer.Close, thereby implementingio.Closer.This revision also formats the server sources with the standard formatter (
gofmt), to be a bit more idiomatic.Notes
A few months ago, I had started a refactor of the server implementation to implement #19. We use this library internally at Siemens, and not being able to configure a
net.Listenerhas made are adoption a bit difficult. This patch series grew fairly large, so in an effort to keep these changes more easily reviewable, I'll be submitting them for review one at a time.This first patch is just the baseline docs and formatting fixes. There are no functional code changes here, just docs and formatting.
I'm happy to tidy up other project sources too. Just let me know.
Disclosure
These changes are completely organic, written by myself, without the use of AI. I just want to make this clear, given the current landscape..