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

DOC: Refactor "Python as Glue" #20095

Open
HaoZeke opened this issue Oct 11, 2021 · 6 comments
Open

DOC: Refactor "Python as Glue" #20095

HaoZeke opened this issue Oct 11, 2021 · 6 comments

Comments

@HaoZeke
Copy link
Member

HaoZeke commented Oct 11, 2021

Issue with current documentation:

At a recent docs meeting, it was noted that the "Python as Glue" is written in a style unlike the rest of the docs.

Note that this is not a priority, and simply a minor tracking issue.

Idea or request for content:

No response

@hassanrahim26
Copy link

Hey @HaoZeke, I'm new to this organisation and I want to contribute to this issue. Can you please tell me ways to get started.

@mattip
Copy link
Member

mattip commented Oct 13, 2021

The intent is to rewrite this page. The source for that is numpy/doc/source/user/c-info.python-as-glue.rst. In order to understand the workflow for changing documentation, please try out the gitpod guide and read about documentation development. Once you understand the technical details and the workflow, you need to think about the intent of the comment above: read the page and the other documentation and try to understand what is different about the style of this page, and how you can change it to match the rest of the documentation.

@hassanrahim26
Copy link

The intent is to rewrite this page. The source for that is numpy/doc/source/user/c-info.python-as-glue.rst. In order to understand the workflow for changing documentation, please try out the gitpod guide and read about documentation development. Once you understand the technical details and the workflow, you need to think about the intent of the comment above: read the page and the other documentation and try to understand what is different about the style of this page, and how you can change it to match the rest of the documentation.

@mattip, thank you so much for telling me. I'll go through the guide which you mentioned and after understanding the workflow, I'll start contributing. 😃

@Mukulikaa
Copy link
Contributor

Hi @hassanrahim26, you might also find NEP 44 useful. It talks about how the documentation is supposed to be restructured. It might give you ideas on where to place "Python as a Glue" and which style to rewrite it in.

@hassanrahim26
Copy link

Hi @hassanrahim26, you might also find NEP 44 useful. It talks about how the documentation is supposed to be restructured. It might give you ideas on where to place "Python as a Glue" and which style to rewrite it in.

@Mukulikaa, thanks for telling. I'll look into it 😄

@JEMA99
Copy link

JEMA99 commented Dec 14, 2021

participate in the problems, it is important that they help us

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants