Skip to content

Refactor documentation and project description #46

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.

Sign up for GitHub

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

Jump to bottom
Merged
saudzahirr merged 2 commits into from
Jan 21, 2026
Merged

Refactor documentation and project description #46

saudzahirr merged 2 commits into from
Jan 21, 2026

Conversation

@saudzahirr
Copy link
Collaborator

@saudzahirr saudzahirr commented Jan 20, 2026

  • Update README
  • Update pyproject.toml
  • Update documentation and updated assets

@saudzahirr saudzahirr requested a review from relf January 20, 2026 07:50
@saudzahirr saudzahirr self-assigned this Jan 20, 2026
@saudzahirr saudzahirr added the enhancement New feature or request label Jan 20, 2026
@saudzahirr saudzahirr changed the title Update documentation and project description Refactor documentation and project description Jan 20, 2026
@saudzahirr
Copy link
Collaborator Author

saudzahirr commented Jan 20, 2026

@relf kindly review these changes.

@saudzahirr
Update documentation and project description
bc1d9c2 
* Update README
* Update pyproject.toml
* Update documentation and updated assets
@saudzahirr saudzahirr force-pushed the refactor-docs-and-description branch from 4bcefc0 to bc1d9c2 Compare January 20, 2026 09:13
relf
relf approved these changes Jan 21, 2026
View reviewed changes
Copy link
Owner

@relf relf left a comment

Choose a reason for hiding this comment

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

Thanks @saudzahirr !

By the way, do not hesitate to tell me when you want the to switch to pydoe repository. We will put a message at the top of the README here redirecting people to pydoe and I will archive the pyDOE3 repository.

README.md

[![Stack Overflow](https://img.shields.io/badge/stackoverflow-Ask%20questions-blue.svg)](
https://stackoverflow.com/questions/tagged/pydoe)
[![codecov](https://codecov.io/gh/relf/pydoe3/branch/master/graph/badge.svg?token=DO4KFMPNM0)](https://codecov.io/gh/relf/pydoe3)
Copy link
Owner

@relf relf Jan 21, 2026

Choose a reason for hiding this comment

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

Maybe this badge will be added in pydoe when the coverage is properly established

Copy link
Collaborator Author

@saudzahirr saudzahirr Jan 21, 2026

Choose a reason for hiding this comment

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

Yes!

@saudzahirr
Copy link
Collaborator Author

saudzahirr commented Jan 21, 2026

Thanks @saudzahirr !

By the way, do not hesitate to tell me when you want the to switch to pydoe repository. We will put a message at the top of the README here redirecting people to pydoe and I will archive the pyDOE3 repository.

We are currently waiting for the PyPI project name. In the meantime, we will continue maintaining pydoe3. Once @tisimst transfers the project to the pydoe organization on PyPI, we will resume maintenance of the original project.

The issues we should monitor in the meantime are:

For now, I have added this reference:
https://pydoe.github.io/pydoe/credits/#pydoe3

@saudzahirr saudzahirr merged commit 52525af into master Jan 21, 2026
9 checks passed
@saudzahirr saudzahirr deleted the refactor-docs-and-description branch January 21, 2026 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@relf relf relf approved these changes

Assignees

@saudzahirr saudzahirr

Labels

enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@saudzahirr @relf