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

Restructure Read operations page #447

Merged
merged 1 commit into from
Sep 7, 2023
Merged

Restructure Read operations page #447

merged 1 commit into from
Sep 7, 2023

Conversation

sarahhaggarty
Copy link
Collaborator

Hi @zaleslaw,

Here's a suggested restructure of the Read operations page that also can be used as a template for the Write operations page.

The main changes are:

  • to separate topics within the content and place them under their own headers.
  • explicitly state the functions to use for specific operations.
  • give separate examples for the main use cases of each function.

There are also some stylistic changes like changing the headers from using the gerund (e.g. reading) to the imperative (e.g. read). Let me know if you would like these changes to be dropped.

I also fixed the warning at the bottom of the page.

Please let me know your thoughts.

@sarahhaggarty sarahhaggarty added the documentation Improvements or additions to documentation (not KDocs) label Aug 29, 2023
Copy link
Collaborator

@zaleslaw zaleslaw left a comment

Choose a reason for hiding this comment

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

Could you please summarize the recommendation based on these edits?

@zaleslaw zaleslaw merged commit 66d94fb into master Sep 7, 2023
@Jolanrensen Jolanrensen deleted the read-write-operations branch September 8, 2023 13:33
@zaleslaw zaleslaw added this to the 0.12.0 milestone Oct 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation (not KDocs)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants