docs: Document DirectProductElement#6260
Open
limakzi wants to merge 1 commit intogap-system:masterfrom
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds missing reference manual documentation for creating and working with IsDirectProductElement objects via DirectProductElement / DirectProductElementNC, and ensures the new documentation is included in the reference manual build (fixing #3452).
Changes:
- Add GAPDoc for
DirectProductElement/DirectProductElementNC, including indexing/Length, componentwise operations, and worked examples. - Include the new GAPDoc label in the reference manual section index.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
lib/tuples.gd |
Adds a new GAPDoc block documenting DirectProductElement and DirectProductElementNC, with examples. |
doc/ref/mapping.xml |
Includes the new DirectProductElement label so it appears in the manual. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
limakzi
force-pushed
the
3452-document-directproductelement
branch
from
e91f1e8 to
499a2b0
Compare
limakzi
force-pushed
the
3452-document-directproductelement
branch
from
499a2b0 to
4dd3d88
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DirectProductElementandDirectProductElementNCwere previously declared intuples.gdwith an empty<Description>block and noGAPDoclabel, so they did not appear in the manual at all.This PR fills in the documentation, component access via indexing and
Length, and componentwise arithmetic, followed by two worked examples:DirectProduct(G, H)with embeddings and projections.Fixes #3452.