Skip to content

Conversation

@heetrojivadiya
Copy link
Member

I did corrections of docstring in all the files and did some minor code corrections/changes in list of below files. Please review it.

  1. BasicObjects
    line
    thickness

  2. CocreteDesign
    ConcreteServiceabilityConfigurations
    ConcreteUltimateConfiguration

  3. Imperfections
    ImperfectionCase

  4. LoadCaseandCombinations
    designSituation
    loadCombination
    modalAnalysisSettings
    resultCombination
    SpectralAnalysisSettings
    StabilityAnalysisSettings
    StaticAnalysisSettings

  5. Loads
    freeLoad
    lineLoad
    linesetLoad
    memberLoad
    membersetLoad
    solidLoad
    solidsetLoad

  6. SpecialObjects
    resultSection

  7. TypesForLines
    LineWeldedJoint

  8. TypesForMembers
    MemberDefinableStiffness
    MemberEccentricity
    MemberSupport

  9. TypesforConcreteDesign
    ConcreteDurability
    ConcreteEffectiveLength
    ConcreteReinforcementDirection
    ConcreteSurfaceReinforcements

  10. TypesForSolids
    SolidContact

  11. TypesForSteelDesign
    init <--- added for auto documentation

  12. baseSettings

Copy link
Contributor

@OndraMichal OndraMichal left a comment

Choose a reason for hiding this comment

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

Changes seems OK. Merge actual main to this branch to update it. There are conflicts involved. Than we can merge it to main.

@pull-request-quantifier-deprecated

This PR has 2299 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Large
Size       : +1407 -892
Percentile : 100%

Total files changed: 79

Change summary by file extension:
.py : +1407 -892

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

Copy link
Contributor

@OndraMichal OndraMichal left a comment

Choose a reason for hiding this comment

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

159 passed, 7 skipped in 176.29s

@OndraMichal OndraMichal merged commit f2deaa5 into main Aug 16, 2022
@OndraMichal OndraMichal deleted the heet-docstring_changes branch August 16, 2022 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants