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.

Sign up for GitHub

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

Jump to bottom

Add well-known metadata keys #3

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open

Add well-known metadata keys #3

wants to merge 1 commit into from

Conversation

OLEGSHA
Copy link
Owner

@OLEGSHA OLEGSHA commented May 1, 2024 •
edited
Loading

Metadata documentation expansion

Metadata documentation in piwcsprwmodel.h was expanded to cover the following topics:

  • (Unenforced) technical rules for metadata keys and values
  • Some well-known metadata keys, their value formats and meanings
  • Clustering (extended from the previously discussed "supernodes")

Checklist

  • Code compiles with no warnings using GCC
  • Code has no clang-tidy errors/warnings
  • Code compiles with no warnings using clang
  • All tests are up to date
  • All tests pass
  • Code is formatted according to .clang-format
  • Inline documentation is up to date
  • Documentation in include/piwcsprwmodel.h is up to date
  • Doxygen produces no warnings

@OLEGSHA
Expanded metadata documentation
28cc19f 
- Included unenforced technical limitations for metadata keys and
  values
- Included some well-known metadata keys
@OLEGSHA OLEGSHA changed the base branch from main to development May 1, 2024 10:21
@OLEGSHA OLEGSHA self-assigned this May 1, 2024
@OLEGSHA OLEGSHA added documentation Improvements or additions to documentation enhancement New feature or request labels May 1, 2024
@OLEGSHA OLEGSHA closed this May 1, 2024
@OLEGSHA OLEGSHA deleted the add-well-known-metadata-keys branch May 1, 2024 11:36
@OLEGSHA OLEGSHA restored the add-well-known-metadata-keys branch May 2, 2024 14:23
@OLEGSHA OLEGSHA reopened this May 2, 2024
@OLEGSHA OLEGSHA requested a review from Lipovr May 2, 2024 20:43
Lipovr
Lipovr requested changes May 11, 2024
View reviewed changes
Copy link
Collaborator

@Lipovr Lipovr left a comment

Choose a reason for hiding this comment

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

Hello, I think it would be better for readability to extract Well-known metadata keys section into a separate file.

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

@Lipovr Lipovr Lipovr requested changes

Assignees

@OLEGSHA OLEGSHA

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@OLEGSHA @Lipovr