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

Document v0.36 open()'s breaking change #556

Merged
merged 2 commits into from
Jan 24, 2022
Merged

Conversation

olegbespalov
Copy link
Contributor

Document a breaking change of the open() function

@olegbespalov olegbespalov self-assigned this Jan 18, 2022
Copy link
Contributor

@yorugac yorugac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Formulation changes: please see the comment.

A related suggestion: perhaps it makes sense to add "good practice hints"? E.g. it's best if you open files like this: a), b), ...
Unless "best practices" section should be in another place and only linked here. WDYT?

@olegbespalov
Copy link
Contributor Author

A related suggestion: perhaps it makes sense to add "good practice hints"? E.g. it's best if you open files like this: a), b), ...
Unless "best practices" section should be in another place and only linked here. WDYT?

I think it's a good idea, but on the other see that the opening of the files is a hot topic, so maybe it makes sense to add this section of the documentation once we make the improvements (for example, once there is more clarity with that issue)

@olegbespalov olegbespalov changed the base branch from feat/archive-v0.35 to main January 24, 2022 09:00
@olegbespalov olegbespalov requested a review from yorugac January 24, 2022 09:00
@yorugac
Copy link
Contributor

yorugac commented Jan 24, 2022

@olegbespalov yes, agreed on returning to this after grafana/k6#2311 👍

@olegbespalov olegbespalov merged commit dca0d7c into main Jan 24, 2022
@olegbespalov olegbespalov deleted the feat/describe-open branch January 24, 2022 09:16
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.

4 participants