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

Unnecessary comment at top of requirements.txt #105

Open
rohitsathish opened this issue Jun 15, 2022 · 4 comments · Fixed by #108
Open

Unnecessary comment at top of requirements.txt #105

rohitsathish opened this issue Jun 15, 2022 · 4 comments · Fixed by #108
Labels

Comments

@rohitsathish
Copy link

Pigar is a very useful package, it saves developers time in creating a requirements.txt.

However, there is an unnecessary comment at the top.

# Automatically generated by https://github.com/damnever/pigar.

pandas == 1.4.2

This persists even if the --without-referenced-comments has been set. It would be helpful if that comment were removed, at least when this option is set, so we don't have go into the .txt to remove it each time. It kind of is against the idea of automating the requirements.txt.

@damnever
Copy link
Owner

Which version are you using? This seems like bug.

@damnever damnever added the bug label Jun 19, 2022
@damnever damnever linked a pull request Jun 22, 2022 that will close this issue
@bitjerry
Copy link

Sorry to bother you, has this been resolved?
The generated files still contain # Automatically generated by https://github.com/damnever/pigar. , what options are there to turn it off?
The version is 2.1.1

@damnever damnever reopened this Oct 14, 2023
@damnever
Copy link
Owner

I believe this issue may have been closed by accident. The top line comment serves as a reminder. You can find that protobuf and other tools put a similar line, since your edition may be overridden by pigar again.

However, providing an extra option to disable it would be acceptable.

@bitjerry
Copy link

For example pipreqs won't have such comments, it looks clean. But it has many problems. Anyway, hope you can add an option to disable it, thank you!

I believe this issue may have been closed by accident. The top line comment serves as a reminder. You can find that protobuf and other tools put a similar line, since your edition may be overridden by pigar again.

However, providing an extra option to disable it would be acceptable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants