human-essentials icon indicating copy to clipboard operation
human-essentials copied to clipboard

On distribution, state should be status

Open cielf opened this issue 1 year ago • 2 comments

Summary

"state" on Distribution is really status, and should be referred to as such throughouth

Why?

Avoiding confusion. Consistency.

Details

Off the cuff, we know that state is used on the distribution in several places -- 1/ the name of the variable is state, 2/ the index, 3/ the export. It may be in other places too.

We should change the name of the variable to status, and ensure that the headings/labels wherever it is shown to the users is Status as well.

And, of course, update any tests that use it.

Criteria for completion

  • [ ] make the changes as indicated above
  • [ ] tests changed and pass
  • [ ] if the distribution section of the user guide (see docs/user_guide/essentials_distributions.md) has been drafted, update it to include this change as well. (may require screenshots)

cielf avatar Aug 18 '24 14:08 cielf

I'd like to take this issue, could you assign me?

noahdurbin avatar Aug 18 '24 17:08 noahdurbin

Sure!

cielf avatar Aug 19 '24 13:08 cielf

This issue is marked as stale due to no activity within 30 days. If no further activity is detected within 7 days, it will be unassigned.

github-actions[bot] avatar Sep 19 '24 00:09 github-actions[bot]

Automatically unassigned after 7 days of inactivity.

github-actions[bot] avatar Sep 27 '24 00:09 github-actions[bot]

hi @cielf, can you assign this issue to me. i would like to take this up

lit-poks avatar Sep 27 '24 10:09 lit-poks

It's yours!

cielf avatar Sep 27 '24 13:09 cielf

#4670

Ready for review @cielf

lit-poks avatar Sep 29 '24 10:09 lit-poks