search

Bachmann1234 / diff_cover

Automatically find diff lines that need test coverage.
Apache License 2.0
698 stars 190 forks source link

ReadTheDocs.io page is out of date. #420

Closed alanmcruickshank closed 3 days ago

alanmcruickshank commented 1 week ago

It looks like the readthedocs.io page for this project is out of date (https://diff-cover.readthedocs.io/en/latest/README.html). From what I can tell from the git blame of README.rst, it looks like the link broke at least 3 months ago (i.e. the changes from #410 are not included).

For now we're updating the SQLFluff docs to point directly at the GitHub repo, but I thought I should let you folks know that it looks like something has gone wrong with the readthedocs integration.

Bachmann1234 commented 1 week ago

Yep, checking this out now

Bachmann1234 commented 1 week ago

hey @alanmcruickshank im kinda leaning to just keeping the readme as is. Will that cause any downsides for yall?

I looked into reviving the readthedocs setup and while its not too bad im worried its gonna introduce more complexity and another place to remember to bump the version.

Are there benefits if the readme is the only docs?

alanmcruickshank commented 4 days ago

@Bachmann1234 - I think Readme on the GitHub repo is fine 👍 . If you're not planning on reviving the readthedocs setup, perhaps could I suggest taking it down? It it's current state it just adds more confusion.

Given it was just a single page before, it doesn't seem like you lose much by just directing people to GitHub 🤷‍♂️

Thanks for maintaining this project! ❤️ Much appreciated.

Bachmann1234 commented 4 days ago

@Bachmann1234 - I think Readme on the GitHub repo is fine 👍 . If you're not planning on reviving the readthedocs setup, perhaps could I suggest taking it down? It it's current state it just adds more confusion.

Given it was just a single page before, it doesn't seem like you lose much by just directing people to GitHub 🤷‍♂️

Thanks for maintaining this project! ❤️ Much appreciated.

Should already be down. I deleted the project when I was looking into how to fix the build.

alanmcruickshank commented 3 days ago

Should already be down. I deleted the project when I was looking into how to fix the build.

image

Confirmed. Awesome. Will close this issue 👍

Thanks again!