Enhancement of Parameter Descriptions in MatrixPlot Class Documentation

[wassmi]

What kind of feature would you like to request?

Additional function parameters / changed functionality / changed defaults?

Please describe your wishes

Issue Description

In examining the MatrixPlot class within the provided code, it appears that the documentation for some parameters could be enhanced for clarity and completeness. This improvement is crucial for users to understand how to effectively utilize the class and its functionalities.

Specific Areas for Improvement

While the overall structure of the documentation is good, certain parameters are not described in detail, which might lead to ambiguity in their application. Notably:

• Parameters like use_raw, log, num_categories, categories_order, etc.: The existing documentation does not provide enough context or explanation about what each of these parameters does, their expected data types, default values, and how they influence the behavior of the plot.

• Complex Parameters: Parameters that involve more complex concepts or data structures, such as var_names, groupby, var_group_positions, and values_df, would benefit significantly from more detailed descriptions and examples.

• Method style and Its Parameters: The style method within the MatrixPlot class modifies plot visual parameters, but the implications and use cases of changing parameters like cmap, edge_color, and edge_lw are not well-explained.

Suggested Improvements

To address these issues, I recommend the following enhancements:

1. Detailed Parameter Explanations: Expand on the description of each parameter, especially those that are complex or not self-explanatory. This should include the type of data expected, default values, and a clear explanation of the parameter’s role and impact.

2. Include Examples and Use Cases: For complex parameters, providing examples or typical use cases can be extremely helpful. This could be in the form of small code snippets or scenarios illustrating when and how to use these parameters effectively.

3. Consistency in Documentation Style: Ensure that the documentation style is consistent across different parameters, making it easier for users to read and understand.

Conclusion

Enhancing the documentation of the MatrixPlot class will improve the library's usability and user experience.

I am new to open-source contribution and I am eager to contribute to this enhancement, and welcome any additional input or guidance from the project maintainers and community.

[Zethson]

@wassmi would you be willing to file a PR to suggest some improvements, please? Note that we ideally don't have super verbose parameter descriptions as some functions already have big function signatures.