updated documentation instances of neighbour to neighbor for consistency

[ekohilas]

I noticed that there were inconsistencies with the spelling of "neighbor" as "neighbour" when recently using your library, and I wanted to contribute back given it's hackoctoberfest and make some quick updates to the spelling for consistency, correcting the instances to the american versions (which is what I assume is the preffered in this repository)

These were all the instances of "neighbour" in the documentation according to my recursive grep search.

[ekohilas]

Additionally, it would be appreciated if the "hacktoberfest-accepted" label could be added to the PR, if this repository is open to it :)

[rossbar]

I'm -1 on style changes to the documentation. Networkx doesn't have a policy re: documentation style, and I'm -1 on adopting changes that imply one.

There are many places where the documentation can be improved by adding things that are missing or improving technical accuracy, but I'm going to close this to avoid spending cycles on wordings.

[ekohilas]

Hi @rossbar,

I would be understanding, however I came across another issue today where this came up. Knowing British English, it can be quite frustrating when searching through documentation using your localisation (which is understandable). But I think it's worse if you search through documentation and you have two different sets of results.

For example, the searches with neighbour vs neighbor

If I was a new user of this repository and wasn't used to using american English, those first results would be deceiving, and would make me think that what I was looking for doesn't exist. And from the other perspective, the results would be incomplete (which I think is a more important issue, especially for something as abundant as neighbors)

[ekohilas]

Additionally, could you please explain what you mean by spending cycles? Is there a cost to submitting pull requests? I couldn't find any mention of this in the contributing documentation.

[rossbar]

Thanks for following up @ekohilas

You make a good point about the documentation search, that's something I hadn't considered. In a perfect world, the search functionality would be robust enough to handle such cases, but as it stands that's clearly not the case.

The point I had tried to convey was to generally discourage subjective changes to the documentation. Without the search results as a motivation, this struck me as a simple preference for one wording over the other. TBH this may have been an overreaction on my part due to the mention of hacktoberfest, which is notorious for causing a lot of maintenence burden :)

Additionally, could you please explain what you mean by spending cycles?

Sorry, not very clear wording on my part --- I was referring to reviews. In most cases, PRs require review & approval from at least two people, and reviews take time. I (seemingly unfairly) saw multiple PRs with "neighbour"->"neighbor" proposals and assumed they were the opening salvo of such proposals ("colour" -> "color"; "localise" -> "localize", etc.) and I wanted to head that off.

Anyways - your point about the search is a good one (maybe worth raising with sphinx?). Feel free to re-open (perhaps folding in the changes from #4308 in here as well).

[jarrodmillman]

@ekohilas Please fold in your changes from #4308 incorporating Dan's suggestions regarding using nbr for variable names.

[MridulS]

Made the changes in #7162, thanks for opening this @ekohilas !