Skip to content

docs: improve docs of assortativity#1151

Merged
aviator-app[bot] merged 11 commits intomainfrom
tbd
Jan 30, 2024
Merged

docs: improve docs of assortativity#1151
aviator-app[bot] merged 11 commits intomainfrom
tbd

Conversation

@maelle
Copy link
Copy Markdown
Contributor

@maelle maelle commented Jan 22, 2024

@maelle maelle added this to the upgrade milestone Jan 22, 2024
@maelle maelle requested a review from szhorvat January 22, 2024 13:18
@aviator-app
Copy link
Copy Markdown
Contributor

aviator-app bot commented Jan 22, 2024

Current Aviator status

Aviator will automatically update this comment as the status of the PR changes.
Comment /aviator refresh to force Aviator to re-examine your PR (or learn about other /aviator commands).

This PR was merged using Aviator.


See the real-time status of this PR on the Aviator webapp.

Use the Aviator Chrome Extension to see the status of your PR within GitHub.

@szhorvat
Copy link
Copy Markdown
Member

I'll need to have a more thorough read later, but the documentation should be read carefully and updated as a whole. We need to make sure that the description / formulas for assortativity match the updated included in the C core docs.

What happened here (in the C library) was that a more general version of assortativity for implemented, and the docs were significantly expanded.

@maelle

This comment was marked as off-topic.

@szhorvat

This comment was marked as off-topic.

@szhorvat

This comment was marked as resolved.

@szhorvat

This comment was marked as resolved.

@szhorvat

This comment was marked as resolved.

@szhorvat

This comment was marked as resolved.

@szhorvat
Copy link
Copy Markdown
Member

I'm sorry, this was a very sloppy review by me, but with this the docs should at least be accurate and complete. We can fix them up when we have the time, after 2.0 ...

@maelle maelle requested a review from szhorvat January 23, 2024 11:58
@maelle
Copy link
Copy Markdown
Contributor Author

maelle commented Jan 23, 2024

It didn't seem sloppy! I've made changes.

@krlmlr krlmlr marked this pull request as draft January 23, 2024 12:17
@krlmlr krlmlr modified the milestones: upgrade, upgrade-2 Jan 23, 2024
@maelle
Copy link
Copy Markdown
Contributor Author

maelle commented Jan 29, 2024

@szhorvat could you please re-review this? 🙏

Copy link
Copy Markdown
Member

@szhorvat szhorvat left a comment

Choose a reason for hiding this comment

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

I think this should be merged now, as it is all correct. I'll try to make improvements later. Thank you Maëlle!

@maelle maelle marked this pull request as ready for review January 30, 2024 12:00
@maelle maelle changed the title docs: add documentation for "normalized" parameter for assortativity docs: improve docs of assortativity Jan 30, 2024
@aviator-app aviator-app bot merged commit c1313e2 into main Jan 30, 2024
@aviator-app aviator-app bot deleted the tbd branch January 30, 2024 12:33
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 30, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Replace @param normalized TBD

3 participants