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

changed file extension from .txt to .rst #5542

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

hnhparitosh
Copy link

Due to file extension, the file was not being rendered properly.
Now, contributors can view this page properly

Description

Checklist

For reviewers

  • Check that the PR title is short, concise, and will make sense 1 year
    later.
  • Check that new functions are imported in corresponding __init__.py.
  • Check that new features, API changes, and deprecations are mentioned in
    doc/release/release_dev.rst.

Due to file extension, the file was not being rendered properly.
Now, contributors can view this page properly
Due to file extension, the file was not being rendered properly.
Now, contributors can view this page properly
Copy link
Contributor

@grlee77 grlee77 left a comment

Choose a reason for hiding this comment

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

Thanks, @hnhparitosh! Two suggestions:

1.) You need to also update the line starting with .. include in doc/source/contribute.rst to point to CONTRIBUTING.rst instead of CONTRIBUTING.txt. Otherwise, this causes the online doc page for this to be empty (see the documentation that was rendered from the prior build in this PR here). Also, I don't think there is any link in the Sphinx docs to the CONTRIBUTORS file, so nothing to update there for that one.

2.) CONTRIBUTORS.txt looks like it is in Markdown format (e.g. headers marked with # instead of underscores). I would rename this one to CONTRIBUTORS.md instead.

@grlee77 grlee77 added the 📄 type: Documentation Updates, fixes and additions to documentation label Aug 27, 2021
The document is in markdown format, the file extension is changed to .md for proper rendering
@grlee77
Copy link
Contributor

grlee77 commented Sep 2, 2021

please also address this comment:

1.) You need to also update the line starting with .. include in doc/source/contribute.rst to point to CONTRIBUTING.rst instead of CONTRIBUTING.txt

@mkcor
Copy link
Member

mkcor commented Sep 8, 2021

Dear @hnhparitosh,

Are you able to take care of the changes requested by Greg? Feel free to let us know.

Cheers,
Marianne

@mkcor
Copy link
Member

mkcor commented Dec 2, 2021

Hi @hnhparitosh,

Can you update this PR or would you like us to take over?

@hmaarrfk
Copy link
Member

hmaarrfk commented Dec 2, 2021

Sorry i missed this one and merged an other PR instead :/

@mkcor
Copy link
Member

mkcor commented Dec 3, 2021

Sorry i missed this one and merged an other PR instead :/

Oh, which one? 👀

@hmaarrfk
Copy link
Member

hmaarrfk commented Dec 3, 2021

https://github.com/scikit-image/scikit-image/pull/6070/files

@mkcor
Copy link
Member

mkcor commented Dec 3, 2021

@hnhparitosh I have resolved the merge conflicts through the web interface. Unrelated, but next time please work on a dedicated feature branch to submit a contribution, as detailed in... CONTRIBUTING.rst 😉

@hmaarrfk
Copy link
Member

hmaarrfk commented Dec 3, 2021

./doc/release/release_0.17.rst:- Deprecate CONTRIBUTORS.txt and replace by git shortlog command (#4351)
./INSTALL.rst:    ├── CONTRIBUTORS.txt

CONTRIBUTING.rst Outdated Show resolved Hide resolved
@hmaarrfk
Copy link
Member

hmaarrfk commented Dec 3, 2021

Gah. I can't get the whitespace change to go away. Sorry for the many pushes.

@mkcor mkcor requested a review from grlee77 December 4, 2021 15:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 type: Documentation Updates, fixes and additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants