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.

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

sequential: refactor, and update godoc #127

Merged
merged 5 commits into from Jul 17, 2023

Conversation

thaJeztah
Copy link
Member

@thaJeztah thaJeztah commented Jun 10, 2023

sequential: consistently use x/sys/windows for consts

Don't mix-and-mash packages for consts.

sequential: open(File)Sequential: remove unused arg

sequential: move error-handling to openFileSequential

Move the error-handling to openFileSequential and update exported functions to use openFileSequential instead of OpenFile().

sequential: simplify docs for non-Windows implementations

The non-Windows implementations are aliases for the "os" stdlib package equivalents. This patch removes the local documentation, as it was out of date for some, and having the local documentation could give the impression that these functions were anything other than an alias.

Screenshot 2023-06-10 at 12 02 00

sequential: update docs for Windows-implementation

Update the docs to refer to the "os" stdlib equivalents, and describe the changes compared to those, instead of replicating the os package's documentation.

Screenshot 2023-06-10 at 12 32 45

Don't mix-and-mash packages for consts.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Move the error-handling to openFileSequential and update exported
functions to use openFileSequential instead of OpenFile().

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
The non-Windows implementations are aliases for the "os" stdlib package
equivalents. This patch removes the local documentation, as it was out
of date for some, and having the local documentation could give the
impression that these functions were anything other than an alias.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Update the docs to refer to the "os" stdlib equivalents, and describe
the changes compared to those, instead of replicating the os package's
documentation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah
Copy link
Member Author

@kolyshkin @cpuguy83 PTAL

@thaJeztah
Copy link
Member Author

@kolyshkin @cpuguy83 @AkihiroSuda PTAL 🤗

@thaJeztah
Copy link
Member Author

Thx! Let me bring this one in

@thaJeztah thaJeztah merged commit eac9a7f into moby:main Jul 17, 2023
9 checks passed
@thaJeztah thaJeztah deleted the sequential_cleanup branch July 17, 2023 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants