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

remove version number from doc blocs #1344

Merged
merged 1 commit into from
May 30, 2024
Merged

remove version number from doc blocs #1344

merged 1 commit into from
May 30, 2024

Conversation

elrido
Copy link
Contributor

@elrido elrido commented May 28, 2024

This PR addresses a discussion item in #1334.

@version at file header level isn't used in code docs, it is intended for API versions at class or method level. See phpdoc documentation, as well as our current PHP & JS docs not displaying/using the version property at all.

Changes

  • remove version number from doc blocs
  • avoids needing to update all these files on version increment
  • avoids needing to regenerate SRI hashes for privatebin.js through extra phpunit run
  • simplifies VERSION_FILES list
  • avoids having to filter above list during loop
  • adds a few missing doc bloc headers

- @Version in file header level isn't used on code docs, it is intended
  for API versions at class or method level
- avoids needing to update all these files on version increment
- avoids needing to regenerate SRI hashes for privatebin.js through
  extra phpunit run
- simplifies VERSION_FILES list
- avoids having to filter above list during loop
- adds a few missing doc bloc headers
@elrido elrido requested a review from rugk May 29, 2024 20:49
@elrido elrido merged commit b9d24b7 into master May 30, 2024
16 of 18 checks passed
@elrido elrido deleted the version-sed branch May 30, 2024 16:52
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.

None yet

2 participants