Add missing docstrings #40
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Flaminietta
added
code quality
|
@mspada @kapil-agnihotri let me take care of fixing the tests before starting your review. Failures unexpected. |
|
@mspada @kapil-agnihotri tests are fixed, you can start reviewing it. |
|
@mspada, neither Kapil nor I have been able to run pdoc successfully. Would you try it once? |
|
@Flaminietta I tried to run pdoc, but also in my case was not successful... |
mcda/configuration/config.py
Outdated
|
|
||
| Methods: | ||
| __init__(input_config: dict): instantiate a configuration object. | ||
| _validate(input_config, valid_keys, str_values, int_values, list_values, dict_values): validate the input configuration. |
There was a problem hiding this comment.
I think this line will give linting error. Seems to be crossing 120.
Did you run linting on this branch?
mcda/mcda_functions/aggregation.py
Outdated
| and estimates the scores over the indicators, per alternative. | ||
| Weighted-sum or additive aggregation function gets as input the normalized values of the indicators in a matrix | ||
| and estimates the scores over the indicators, per alternative. The norm_indicators has | ||
| shape = (no.alternatives x num. indicators) and the returned scores has length = num. of alternatives. |
There was a problem hiding this comment.
no.?
num. indicators? is space indented? Either something similar to length = num. of alternatives.?
mcda/mcda_without_robustness.py
Outdated
| Aggregate the normalized indicators using the specified aggregation method. | ||
|
|
||
| Parameters: | ||
| - normalized_indicators: a dictionary containing the normalized values of each indicator per normalization method. |
mcda/utils/utils_for_main.py
Outdated
| :param num_weights: int | ||
| :param num_runs: |
There was a problem hiding this comment.
Following your standards want to specify the type?
|
|
||
| ``` | ||
|
|
||
| This example initializes an Aggregation object with the given weights and calls the specified aggregation method |
kapil-agnihotri
approved these changes
Mar 15, 2024
mspada
approved these changes
Mar 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add missing doctrings to non-private function and non-static methods (that receive only a brief description).
Some docstrings include a running example but not all.
Add minor refinements to fulfill consistency of adopted standards.