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

docs: update biorxiv citation for prancSTR #235

Merged
merged 3 commits into from
Oct 23, 2024

Conversation

aarushi03
Copy link
Contributor

@aarushi03 aarushi03 commented Oct 8, 2024

Edited the prancSTR citation in the README with the published paper. The previous citation only accounted for the bioRX paper.

Checklist

  • I've checked to ensure there aren't already other open pull requests for the same update/change
  • I've prefixed the title of my PR according to the conventional commits specification. If your PR fixes a bug, please prefix the PR with fix: . Otherwise, if it introduces a new feature, please prefix it with feat: . If it introduces a breaking change, please add an exclamation before the colon, like feat!: . If the scope of the PR changes because of a revision to it, please update the PR title, since the title will be used in our CHANGELOG.
  • At the top of the PR, I've listed any open issues that this PR will resolve. For example, "resolves #0" if this PR resolves issue #0
  • I've explained my changes in a manner that will make it possible for both users and maintainers of TRTools to understand them
  • I've added tests for any new functionality. Or, if this PR fixes a bug, I've added test(s) that replicate it
  • All directories with large test files are listed in the "exclude" section of our pyproject.toml so that they do not appear in our PyPI distribution. All new files are also smaller than 0.5 MB.
  • I've updated the relevant REAMDEs with any new usage information and checked that the newly built documentation is formatted properly
  • All functions, modules, classes etc. still conform to numpy docstring standards
  • (if applicable) I've updated the pyproject.toml file with any changes I've made to TRTools's dependencies, and I've run poetry lock --no-update to ensure the lock file stays up to date and that our dependencies are locked to their minimum versions
  • In the body of this PR, I've included a short address to the reviewer highlighting one or two items that might deserve their focus

Edited the prancSTR citation in the README with the published paper.
@aarushi03 aarushi03 changed the title Updated README.rst fix: updated prancSTR README Oct 8, 2024
@aarushi03 aarushi03 requested a review from aryarm October 8, 2024 23:25
@aarushi03 aarushi03 self-assigned this Oct 8, 2024
@aryarm aryarm changed the title fix: updated prancSTR README doc: update biorxiv citation for prancSTR Oct 9, 2024
trtools/prancSTR/README.rst Outdated Show resolved Hide resolved
@aryarm aryarm changed the title doc: update biorxiv citation for prancSTR docs: update biorxiv citation for prancSTR Oct 9, 2024
I forgot this is rst, not md
@aarushi03 aarushi03 merged commit 1e45d23 into master Oct 23, 2024
13 checks passed
@aarushi03 aarushi03 deleted the docs-update-prancSTR-README-for-citation branch October 23, 2024 21:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants