Skip to content
This repository has been archived by the owner on Aug 20, 2024. It is now read-only.

Add file line to source link from scaladoc #2072

Merged
merged 1 commit into from
Feb 5, 2021
Merged

Add file line to source link from scaladoc #2072

merged 1 commit into from
Feb 5, 2021

Conversation

johnsbrew
Copy link
Contributor

@johnsbrew johnsbrew commented Feb 5, 2021 •
edited by jackkoenig
Loading

Very simple change but very helpful when navigating from scaladoc to github.
Also update repo path renaming and use the more universal €{FILE_PATH_EXT} rather than €{FILE_PATH}.scala

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you update the FIRRTL spec to include every new feature/behavior?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you state the API impact?
  • Did you specify the code generation impact?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

documentation

API Impact

None

Backend Code Generation Impact

None

Desired Merge Strategy

squash

Release Notes

Add file line to source link from scaladoc

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels?
  • Did you mark the proper milestone (1.2.x, 1.3.0, 1.4.0) ?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you mark as Please Merge?

@johnsbrew johnsbrew mentioned this pull request Feb 5, 2021
Merged
14 tasks
@johnsbrew
Copy link
Contributor Author

Also done for chisel3 repo chipsalliance/chisel#1776

jackkoenig
jackkoenig approved these changes Feb 5, 2021
View reviewed changes
Copy link
Contributor

@jackkoenig jackkoenig left a comment

Choose a reason for hiding this comment

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

I verified this works locally.

This is very cool, thanks @johnsbrew!

@jackkoenig jackkoenig added this to the 1.2.x milestone Feb 5, 2021
@jackkoenig jackkoenig added the Please Merge Accepted PRs that are ready to be merged. Useful when waiting on CI. label Feb 5, 2021
@mergify mergify bot merged commit 6e0e760 into chipsalliance:master Feb 5, 2021
mergify bot pushed a commit that referenced this pull request Feb 5, 2021
@johnsbrew
Add file line to source link from scaladoc (#2072)
ac83418 
Signed-off-by: Jean Bruant <[email protected]>
(cherry picked from commit 6e0e760)

# Conflicts:
#	build.sbt
This was referenced Feb 5, 2021
Open
Merged
mergify bot pushed a commit that referenced this pull request Feb 5, 2021
@johnsbrew
Add file line to source link from scaladoc (#2072)
6aae3c9 
Signed-off-by: Jean Bruant <[email protected]>
(cherry picked from commit 6e0e760)
mergify bot pushed a commit that referenced this pull request Feb 5, 2021
@johnsbrew
Add file line to source link from scaladoc (#2072)
c3b5923 
Signed-off-by: Jean Bruant <[email protected]>
(cherry picked from commit 6e0e760)
@mergify mergify bot mentioned this pull request Feb 5, 2021
Merged
@mergify mergify bot added the Backported This PR has been backported to marked stable branch label Feb 5, 2021
@johnsbrew johnsbrew deleted the dev/jean.bruant/add-scaladoc-line-link branch February 5, 2021 18:44
mergify bot added a commit that referenced this pull request Feb 5, 2021
@mergify @johnsbrew
Add file line to source link from scaladoc (#2072) (#2075)
10b99fc 
Signed-off-by: Jean Bruant <[email protected]>
(cherry picked from commit 6e0e760)

Co-authored-by: John's Brew <[email protected]>
mergify bot added a commit that referenced this pull request Feb 5, 2021
@mergify @johnsbrew
Add file line to source link from scaladoc (#2072) (#2074)
ee96b68 
Signed-off-by: Jean Bruant <[email protected]>
(cherry picked from commit 6e0e760)

Co-authored-by: John's Brew <[email protected]>
@seldridge
Copy link
Member

Sweet! This is great, thanks!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jackkoenig jackkoenig jackkoenig approved these changes

Assignees
No one assigned
Labels
Backported This PR has been backported to marked stable branch Please Merge Accepted PRs that are ready to be merged. Useful when waiting on CI.
Projects
None yet
Milestone
1.2.x
Development

Successfully merging this pull request may close these issues.
3 participants
@johnsbrew @seldridge @jackkoenig