Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix types of argument and return variables of functions in their docstrings #79

Merged
merged 1 commit into from
Mar 22, 2022
Merged

Fix types of argument and return variables of functions in their docstrings #79

merged 1 commit into from
Mar 22, 2022

Conversation

LINAMARIAOSORIO
Copy link
Collaborator

@LINAMARIAOSORIO LINAMARIAOSORIO commented Mar 17, 2022 •
edited by soaressgabriel
Loading

Checklist:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Added tests for changed code.
  • Updated documentation for changed code.

Description

Apply changes to the docstrings of functions in RUBEM modules to reflect the correct types of arguments and their return.

Related Issue

#78

Motivation and Context

Properly document the arguments and return types of functions.

How Has This Been Tested

Run the RUBEM script in debug mode and check the types of the function's argument and return variables.

@soaressgabriel soaressgabriel changed the title Corrige tipologia variáveis funções Fix types of argument and return variables of functions in their docstrings Mar 22, 2022
@soaressgabriel soaressgabriel self-assigned this Mar 22, 2022
@soaressgabriel soaressgabriel added bug Something isn't working documentation Improvements or additions to documentation labels Mar 22, 2022
@soaressgabriel soaressgabriel added this to the v0.1.0-alpha milestone Mar 22, 2022
@soaressgabriel soaressgabriel linked an issue Mar 22, 2022 that may be closed by this pull request
Fix variable types in module docstrings #78
Closed
@soaressgabriel soaressgabriel merged commit 9e318c0 into development Mar 22, 2022
@soaressgabriel soaressgabriel deleted the 78-fix-variable-types-in-module-docstrings branch July 19, 2022 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@soaressgabriel soaressgabriel soaressgabriel approved these changes

Assignees

@soaressgabriel soaressgabriel

Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
v0.1.0-alpha
Development

Successfully merging this pull request may close these issues.

Fix variable types in module docstrings
2 participants
@LINAMARIAOSORIO @soaressgabriel