Comments (10)
On Tue, Mar 03, 2015 at 12:38:57PM -0800, Alexander Konovalov wrote:
The documentation says that it
loads the GAP package with name `name`.
I think it should be formulated as
loads the GAP package with name given by the string `name`".
(just today I referred to the manual a novice user who was trying
to load package withLoadPackage(sglppow)
without quotes around
the package name, and then we figured out that this may not be so
obvious...)
In my opinion making the sentence more complicated does not help anyone.
I suggest the following:
Leave the first cited sentence as it is and add a short example after it.
This should just show the loading of a package, without the rarely used
fancy optional arguments. And maybe a second example with an abbreviated
package name.
All the other fairly technical documentation (which must be there) can
follow after the example, it is not needed by most GAP users.
from gap.
@frankluebeck : thanks, I agree that example would be even better!
from gap.
I can do this. Is this required or finished?
from gap.
@sr-murthy: Thanks - it's just waiting here for some one to have a look, so please go ahead if you'd like to. Adding example in GAPDoc, please use Log
element instead of Example
to exclude it from automated tests of manual examples.
from gap.
OK, which specific file needs to be changed, I am assuming this is somewhere in gap/doc
.
from gap.
The starting point is gap/doc
, indeed. It has subdirectories tut
, ref
and changes
for respective manuals. This piece is from ref
from the chapter on GAP packages which is ref/gappkg.xml
. When you will find a place of this section there, you will see the line
<#Include Label="LoadPackage">
which includes documentation from the source code. This means that somewhere in the lib
directory there should be a file with the line
<#GAPDoc Label="LoadPackage">
containing the documentation. Easy to find out that this is lib/package.gd
which should be changed.
from gap.
Am a bit busy with some projects right now, will get this done soon.
from gap.
Am working on this right now, and should have it done shortly.
from gap.
Following the questions coming from PR #155, I've created a Wiki page "Building main GAP manuals", see https://github.com/gap-system/gap/wiki/Building-main-GAP-manuals. Hope this will be useful.
from gap.
This issue is closed by PR #155.
from gap.
Related Issues (20)
- `IsomorphismGroups` regression in 4.13.0 HOT 3
- volatile's to be used in libgap-calling functions? HOT 8
- Transitive groups issue with `ConjugacyClassesSubgroups` HOT 2
- Hook up `CharTableAlternating` for alternating group HOT 1
- Bug in `MinimalFaithfulPermutationDegree` HOT 1
- `ConfluentMonoidPresentationForGroup` variant for permutation groups with short stabilizer chain? HOT 1
- Size(g) gives wrong value for presentation aa,ababab,abbab' HOT 8
- `ReadPackage` should error when given an invalid path, not silently proceed HOT 2
- Build instructions do not say how to obtain necessary packages. HOT 1
- When using ACE for coset enumeration, automatic table resizing loops forever HOT 9
- Evaluation of SLPs slow HOT 3
- Preparing for GAP 4.13.2
- Problem with the use of `DirectoriesSystemPrograms` HOT 2
- The function `Cite()` produces some incorrect data HOT 1
- Use package extensions in more packages
- Use `LoadKernelExtension` and `IsKernelExtensionAvailable` in more packages
- GAP calculates size of "aaa,abcac'bcc,acb'" as 84 correctly but cannot IdGroup() it? HOT 13
- `Cite` treats "The GAP Team" as the name of a person
- Bug in `MinimalGeneratingSet`
- deprecate `OtherPackagesLoadedInAdvance` HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from gap.