Skip to content

Doc updation for igraph_vcount#2886

Open
aryarathoree wants to merge 2 commits intoigraph:mainfrom
aryarathoree:doc-updation-for-vcount
Open

Doc updation for igraph_vcount#2886
aryarathoree wants to merge 2 commits intoigraph:mainfrom
aryarathoree:doc-updation-for-vcount

Conversation

@aryarathoree
Copy link
Copy Markdown

Hi! I'm an aspiring contributor. While going through the docs I found out that there is no proper description of the cases wherein the specific function doesn't works. I have started with v_count() - that it doesn't handle NULL case. I would to firstly work on docs while going through this project.
Thanks

  • By submitting this pull request, I assign the copyright of my contribution to The igraph development team.

@szhorvat
Copy link
Copy Markdown
Member

It's good to see your interest in contributing to igraph.

However, in this case I vote against adding this clarification. There is value in conciseness.

In igraph, null pointers are only allowed for parameters that are optional. We do not point out when a null pointer is disallowed. That is the usual situation. We only point out the opposite, when a parameter is optional, and may be NULL.

If you are interested in making other contributions to the documentation, we can talk about that. I will probably have capacity for reviewing PRs or proposing documentation projects in February the earliest.

I will leave this open for a while in case other maintainers wish to chime in.

@aryarathoree
Copy link
Copy Markdown
Author

Hi! Thankyou so much for taking out time to clarify about NULL in igraph . I'll find more relevant issues to work on right now.
Thanks again!

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