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 omit_row noise type #143

Merged
merged 6 commits into from
Apr 25, 2023
Merged

Document omit_row noise type #143

merged 6 commits into from
Apr 25, 2023

Conversation

NathanielBlairStahn
Copy link
Contributor

Write a description for the "omit row" noise type

Description

  • Category: documentation
  • JIRA issue: none

I'd be interested to get feedback on the following:

  • Does the first sentence describing row noise sound good, or am I being too general since we don't currently have plans for any row noise besides omission and duplication?
  • Are my examples of reasons for omission good?
  • I opted to 1) get to the config key name and parameter table quickly, 2) keep the description in the parameter table short and simple, and 3) provide a more precise description of how the function actually works after the table. This differs a bit from how we've been documenting column noise -- does it seem ok? Which style do we like better?

Testing

Built locally

@NathanielBlairStahn NathanielBlairStahn added the documentation Improvements or additions to documentation label Apr 25, 2023
@NathanielBlairStahn NathanielBlairStahn requested review from a team, zmbc and pletale as code owners April 25, 2023 06:32
Copy link
Collaborator

@zmbc zmbc left a comment

Choose a reason for hiding this comment

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

I don't find this too inconsistent with what we already have! We don't need to follow exactly the same format with every noise type, and I think this is clear.

docs/source/noise/row_noise.rst Outdated Show resolved Hide resolved
docs/source/noise/row_noise.rst Outdated Show resolved Hide resolved
@NathanielBlairStahn NathanielBlairStahn merged commit 05ea841 into develop Apr 25, 2023
@NathanielBlairStahn NathanielBlairStahn deleted the docs/omit-row branch April 25, 2023 20:37
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants