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.

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

Fixes #57: Improves inheritdoc so that developer documentation is properly referenced on the autogenerated interfaces #63

Conversation

ChaseFlorell
Copy link
Contributor

based on the comments in #57, by using a cref back to the original implementation, we are able to get intellisense working off of autogenerated interfaces.

Resolves #57

@simonmckenzie
Copy link
Contributor

Hi @ChaseFlorell,

There seem to be a lot of whitespace changes - have you run csharpier? Usually the pipeline runs for pull requests and I think you'd have received a lint failure notification - I don't know why it didn't today.

@ChaseFlorell
Copy link
Contributor Author

Hi @ChaseFlorell,

There seem to be a lot of whitespace changes - have you run csharpier? Usually the pipeline runs for pull requests and I think you'd have received a lint failure notification - I don't know why it didn't today.

I have not, I'm not sure how to run it TBH. I'll take a look

@simonmckenzie
Copy link
Contributor

simonmckenzie commented Nov 5, 2024

Hi @ChaseFlorell,
There seem to be a lot of whitespace changes - have you run csharpier? Usually the pipeline runs for pull requests and I think you'd have received a lint failure notification - I don't know why it didn't today.

I have not, I'm not sure how to run it TBH. I'll take a look

This is what's in the pipeline - you should be able to run the same locally.

dotnet tool restore
dotnet csharpier --check .

... I think running without --check will format the files in place.

@ChaseFlorell
Copy link
Contributor Author

Hi @ChaseFlorell,
There seem to be a lot of whitespace changes - have you run csharpier? Usually the pipeline runs for pull requests and I think you'd have received a lint failure notification - I don't know why it didn't today.

I have not, I'm not sure how to run it TBH. I'll take a look

This is what's in the pipeline - you should be able to run the same locally.

dotnet tool restore
dotnet csharpier --check .

... I think running without --check will format the files in place.

Got it, thanks

@ChristianSauer
Copy link
Collaborator

For first time contributors, package maintainers (only me currently) have to approve the pipeline run.
Thats due to security concerns (imagine replacing the pipeline with a bitcoin mining script...)

I really like the PR, if you can get it "green" I will merge it asap

@ChaseFlorell
Copy link
Contributor Author

For first time contributors, package maintainers (only me currently) have to approve the pipeline run. Thats due to security concerns (imagine replacing the pipeline with a bitcoin mining script...)

I really like the PR, if you can get it "green" I will merge it asap

I'm not quite sure what's missing. I ran > dotnet-csharpier . over the solution on my last commit.

@ChaseFlorell
Copy link
Contributor Author

I'm confused because CI reports the following
image

Whereas my local installation of chsharpier shows
image

@ChaseFlorell
Copy link
Contributor Author

ChaseFlorell commented Nov 8, 2024

For first time contributors, package maintainers (only me currently) have to approve the pipeline run. Thats due to security concerns (imagine replacing the pipeline with a bitcoin mining script...)

I really like the PR, if you can get it "green" I will merge it asap

@ChristianSauer I did push a new version, I'm wondering if you can rerun the pipeline?

@ChristianSauer
Copy link
Collaborator

I finally had time to merge this. Thanks for your patience!

@ChristianSauer ChristianSauer merged commit 8bf5aa3 into codecentric:master Nov 29, 2024
3 checks passed
@ChaseFlorell ChaseFlorell deleted the users/CFlorell/task/inheritdoc_improvements branch November 29, 2024 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Interfaces are created with "inheritdoc" xml comments
3 participants