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

Undocumented items in reference manual #2431

Open
6 tasks
olexandr-konovalov opened this issue May 1, 2018 · 2 comments
Open
6 tasks

Undocumented items in reference manual #2431

olexandr-konovalov opened this issue May 1, 2018 · 2 comments
Labels
kind: discussion discussions, questions, requests for comments, and so on kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements topic: documentation Issues and PRs related to documentation

Comments

@olexandr-konovalov
Copy link
Member

olexandr-konovalov commented May 1, 2018

Tried to put cross-references into release overview for GAP 4.9.1 and they did not work:

#W WARNING: non resolved reference: rec(
  Attr := "DirectFactorsOfGroup",
  BookName := "ref" )
#W WARNING: non resolved reference: rec(
  Attr := "SemidirectDecompositions",
  BookName := "ref" )
#W WARNING: non resolved reference: rec(
  Attr := "NormalHallSubgroups",
  BookName := "ref" )
#W WARNING: non resolved reference: rec(
  BookName := "ref",
  Oper := "RootFFE" )
#W WARNING: non resolved reference: rec(
  BookName := "ref",
  Func := "IdOfFilter" )
#W WARNING: non resolved reference: rec(
  BookName := "ref",
  Func := "IdOfFilterByName" )
#I  File: manual.lab written.

Is there no documentation intentionally, or it's there but not hooked into the manual?

  • DirectFactorsOfGroup
  • SemidirectDecompositions
  • NormalHallSubgroups
  • RootFFE
  • IdOfFilter
  • IdOfFilterByName
@olexandr-konovalov olexandr-konovalov added the topic: documentation Issues and PRs related to documentation label May 1, 2018
@olexandr-konovalov olexandr-konovalov added this to the GAP 4.9.1 milestone May 1, 2018
@hulpke
Copy link
Contributor

hulpke commented May 1, 2018

I think the first three were introduced in #379 and #591

RootFFE was never really documented. It got in because some finite field/basic number theory algorithms require a square root and was implements using the internal LogFFE. I think we now also have a method for larger FFE's that are represented differently.
I suspect it was always intended as a more internal function.

We probably should define what we consider as basic and as plausible operations for FFEs.

IdOfFilter (which sounds like Freudian analysis) is defined in filter.gi

@olexandr-konovalov
Copy link
Member Author

@hulpke thanks. RootFFE is also a subject of #2131.

@olexandr-konovalov olexandr-konovalov modified the milestones: GAP 4.9.3, GAP 4.9.4 Sep 1, 2018
@olexandr-konovalov olexandr-konovalov modified the milestones: GAP 4.9.4, GAP 4.11 Jan 26, 2019
@fingolfin fingolfin removed this from the GAP 4.11 milestone Mar 21, 2019
@fingolfin fingolfin added kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements kind: discussion discussions, questions, requests for comments, and so on labels Mar 26, 2019
@ruthhoffmann ruthhoffmann added the gapdays2020-spring Issues and PRs that arose in relation to https://www.gapdays.de/gapdays2020-spring label Nov 6, 2019
@fingolfin fingolfin removed the gapdays2020-spring Issues and PRs that arose in relation to https://www.gapdays.de/gapdays2020-spring label Mar 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: discussion discussions, questions, requests for comments, and so on kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements topic: documentation Issues and PRs related to documentation
Projects
None yet
Development

No branches or pull requests

4 participants