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

Add brief description to the top of .api dumps, to help explain the file and BCV #230

Open
aSemy opened this issue May 29, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@aSemy
Copy link
Contributor

aSemy commented May 29, 2024

Currently the .api dumps have no description. Their purpose is unclear to anyone not familiar with BCV, and there's no easy way to discover that they are created by BCV.

I suggest adding a brief comment to the top of all .api files, covering some basic information:

# Kotlin Binary Compatibility Validator dump file.
# This file is automatically generated, do not modify.
# For more information, see https://github.com/Kotlin/binary-compatibility-validator

[the remaining dump file...]

(I've assumed that BCV would implement a limited comment feature, so BCV would ignore lines at the start of the file that start with #.)

@aSemy aSemy changed the title Add brief description to the top of .api dumps, to help Add brief description to the top of .api dumps, to help explain the file and BCV May 29, 2024
@fzhinkin fzhinkin added the enhancement New feature or request label May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants