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

Refactor docs to use inclusive language. #342

Merged
merged 9 commits into from
Jul 9, 2020
Merged

Refactor docs to use inclusive language. #342

merged 9 commits into from
Jul 9, 2020

Conversation

bdice
Copy link
Member

@bdice bdice commented Jun 25, 2020

Description

This PR refactors some language present in the documentation and API of signac to move towards more inclusive documentation.

Motivation and Context

This PR is motivated by discussion at a recent signac developer meeting.

Types of Changes

  • Documentation update
  • Bug fix
  • New feature
  • Breaking change1

1The change breaks (or has the potential to break) existing functionality.

Checklist:

If necessary:

  • I have updated the API documentation as part of the package doc-strings.
  • I have created a separate pull request to update the framework documentation on signac-docs and linked it here.
  • I have updated the changelog and added all related issue and pull request numbers for future reference (if applicable).

@bdice bdice added the documentation Writing or editing documentation label Jun 25, 2020
@bdice bdice added this to the v1.5.0 milestone Jun 25, 2020
@bdice bdice requested review from a team as code owners June 25, 2020 04:23
@bdice bdice self-assigned this Jun 25, 2020
@bdice bdice requested review from mikemhenry and klywang and removed request for a team June 25, 2020 04:23
changelog.txt Outdated Show resolved Hide resolved
@mikemhenry
Copy link
Collaborator

This looks good, later today I'll have more time to double check that we got everything.

@vyasr vyasr requested review from vyasr and removed request for vyasr June 29, 2020 13:43
@csadorf
Copy link
Contributor

csadorf commented Jul 7, 2020

@klywang Do you think you will be able to have a look at this?

@codecov
Copy link

codecov bot commented Jul 9, 2020

Codecov Report

Merging #342 into master will decrease coverage by 0.02%.
The diff coverage is 78.94%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #342      +/-   ##
==========================================
- Coverage   76.22%   76.19%   -0.03%     
==========================================
  Files          43       43              
  Lines        7096     7104       +8     
==========================================
+ Hits         5409     5413       +4     
- Misses       1687     1691       +4     
Impacted Files Coverage Δ
signac/contrib/indexing.py 75.35% <75.00%> (-0.25%) ⬇️
signac/contrib/project.py 91.31% <77.77%> (-0.24%) ⬇️
signac/__main__.py 80.04% <100.00%> (ø)
signac/contrib/__init__.py 92.85% <100.00%> (+0.26%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b0222df...96ef55e. Read the comment docs.

Copy link
Contributor

@klywang klywang left a comment

Choose a reason for hiding this comment

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

Everything looks good!

@bdice bdice merged commit 5be804c into master Jul 9, 2020
@bdice bdice deleted the refactor-language branch July 9, 2020 15:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Writing or editing documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants