Skip to content

Provide references to invoked methods in summary - #476

Merged
onewhl merged 4 commits into
mainfrom
onewhl/462-links
Jul 18, 2022
Merged

Provide references to invoked methods in summary#476
onewhl merged 4 commits into
mainfrom
onewhl/462-links

Conversation

@onewhl

@onewhlonewhl commented Jul 11, 2022

Copy link
Copy Markdown
Member

Description

Provide references to invoked methods in summary to make it possible to navigate to them by click.
Fixes#462

Type of Change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Automated Testing

I fixed the tests affected by the change and added them to this PR.

Manual Scenario

I ran the plugin on several code snippets to make sure that the links the plugin shows are correct.

Checklist (remove irrelevant options):

  • The change followed the style guidelines of the UTBot project
  • Self-review of the code is passed
  • The change contains enough commentaries, particularly in hard-to-understand areas
  • New documentation is provided or existed one is altered
  • No new warnings
  • Tests that prove my change is effective
  • All tests pass locally with my changes

@onewhl
onewhl requested a review from amandelpieJuly 11, 2022 09:25
@onewhlonewhl added the comp-summaries Something related to the method names, code comments and display names generation label Jul 11, 2022
* to render the reference.
*/
protected fun invokeDescription(className: String, methodName: String) = "$className::$methodName" //TODO SAT-1311
protected fun invokeDescription(className: String, methodName: String, methodParameterTypes: List<Type>): String {

@amandelpieamandelpieJul 18, 2022

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I have a simple note for the future (let's cover this functionality with the unit tests located in the summary module itself)
I'm going to merge first test with DBSCAN #345 issue and you could create a ticket to cover it with the unit functionality without test generation from scratch.

I suggest to cover all known builders, it will be easier to see if something broken there. Also you could use UTBot or Fuzzer to generate these unit tests @onewhl

@onewhlonewhlJul 18, 2022

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Sounds awesome, I've created a separate ticket for it: #543

@amandelpieamandelpie left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM for me

@onewhl
onewhl merged commit f5534cd into mainJul 18, 2022
@onewhl
onewhl deleted the onewhl/462-links branch July 18, 2022 10:09
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comp-summariesSomething related to the method names, code comments and display names generation

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Provide references to invoked methods in summary

2 participants

@onewhl@amandelpie