Skip to content

document the supported components of PackageInfo.g - #5376

Merged
fingolfin merged 1 commit into
gap-system:masterfrom
ThomasBreuer:TB_PackageInfo
Feb 10, 2023
Merged

document the supported components of PackageInfo.g#5376
fingolfin merged 1 commit into
gap-system:masterfrom
ThomasBreuer:TB_PackageInfo

Conversation

@ThomasBreuer

Copy link
Copy Markdown
Contributor

Having an exhaustive list of supported PackageInfo.g entries as an official reference is desirable.

The list proposed here was derived from the function ValidatePackageInfo and the contents of the PackageInfo.g file of the Example package.
After discussing this proposal and fixing the contents which we really want to have, these sources should then be adjusted to the list in the Reference Manual.

(Should also the AutoDoc component be mentioned?
When #5375 will be merged, also the Extensions component must be mentioned.)

The list was derived from the function `ValidatePackageInfo`
and the contents of the `PackageInfo.g` file of the `Example` package.
(Should also the `AutoDoc` component be mentioned?)
@ThomasBreuerThomasBreuer added kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements topic: documentation Issues and PRs related to documentation topic: packages issues or PRs related to package handling, or specific to a package (for packages w/o issue tracker) release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes labels Feb 10, 2023

@fingolfinfingolfin left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Great!

@fingolfin
fingolfin merged commit e94baa2 into gap-system:masterFeb 10, 2023
@ThomasBreuer
ThomasBreuer deleted the TB_PackageInfo branch February 11, 2023 19:05
ThomasBreuer added a commit to ThomasBreuer/gap that referenced this pull request Feb 14, 2023
- addressed the comments,
- added the `Extensions` component to the documented components of `PackageInfo.g`,
- improved the description of `PackageInfo.g` (continuing what has been done in gap-system#5376)
fingolfin pushed a commit that referenced this pull request Feb 16, 2023
- addressed the comments,
- added the `Extensions` component to the documented components of `PackageInfo.g`,
- improved the description of `PackageInfo.g` (continuing what has been done in #5376)
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind: enhancementLabel for issues suggesting enhancements; and for pull requests implementing enhancementsrelease notes: not neededPRs introducing changes that are wholly irrelevant to the release notestopic: documentationIssues and PRs related to documentationtopic: packagesissues or PRs related to package handling, or specific to a package (for packages w/o issue tracker)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@ThomasBreuer@fingolfin