-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
base: main
Are you sure you want to change the base?
Conversation
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
There was a problem hiding this 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.
The document is in markdown format, the file extension is changed to .md for proper rendering
please also address this comment:
|
Dear @hnhparitosh, Are you able to take care of the changes requested by Greg? Feel free to let us know. Cheers, |
Hi @hnhparitosh, Can you update this PR or would you like us to take over? |
Sorry i missed this one and merged an other PR instead :/ |
Oh, which one? 👀 |
@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... |
|
Gah. I can't get the whitespace change to go away. Sorry for the many pushes. |
Due to file extension, the file was not being rendered properly.
Now, contributors can view this page properly
Description
Checklist
./doc/examples
(new features only)./benchmarks
, if your changes aren't covered by anexisting benchmark
For reviewers
later.
__init__.py
.doc/release/release_dev.rst
.