Comments (3)
That's a very good point. To fix it, it seems to me we need a system where
the documentation is contained in comments, and is extracted by some
automatic procedure. But writing that would be a pain.
Computers are getting faster, so why not just not use "beginDocumentation"?
On Sun, Mar 24, 2013 at 3:49 PM, jakobkroeker [email protected]:
Hello,
consider a package with code behind 'beginDocumentation()':
if the package is installed by hand or loaded in its directory everything
is fine,but after 'installingPackage' and a Macaulay2 restart, M2 does not
recognize functions placed below 'beginDocumentation'. Even if it is
mentioned in the Macaulay2 documentation,
-this mistake is unfortunately not detected during installation process.
-prevents the programmer to place documentation near to the code it
documents.Question,
can this mistake at least be detected automatically,
or is it possible to allow code behind 'beginDocumentation'?—
Reply to this email directly or view it on GitHubhttps://github.com//issues/12
.
from m2.
Thanks!
If I understand it correctly, to replace 'beginDocumentation()'
without triggering the subtle issue above I have to load "SimpleDoc" and "Text" packages
needsPackage "SimpleDoc";
needsPackage "Text";
to use the doc keyword as before.
Could this explicitly be mentioned in the description of 'beginDocumentation' ?
from m2.
done 3c46824
from m2.
Related Issues (20)
- AssociativeAlgebras crash
- Cannot load package "ToricVectorBundles" in version 1.23 HOT 2
- Pushforward fails for the cuspidal cubic immersion HOT 2
- LengthLimit in Complexes
- Crash on negative rational exponents HOT 2
- RInterface test failures on loong64/riscv64 architectures HOT 1
- toField() leads to a crash HOT 1
- primaryDecomposition issue with nonstandard grading HOT 2
- Negative variable degrees, incorrectly computed Ext/Cohomology
- Polyhedra Package Changes Lineality Space of Fan
- equality of ideals over different rings
- Promotion issues
- Better list comprehension HOT 7
- Redhat Enterprise 8 Build problem HOT 20
- Operator wishlist
- Precision error with hilbert basis HOT 1
- Precedence of subscripts and superscripts HOT 1
- "published article DOI" unused for certified packages HOT 1
- Building with Nix - various problems with the autoconf build process HOT 10
- Add assertLevel and automatic timer
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 m2.