Comments (3)
In general it is unclear right now what thing we want to use for documentation that is not directly related to code. Despite building doc-gen4 I have in fact basically no clue about web development at all :D so implementing this type of prose documentation is something I don't want to invest too much time on when I can instead be helping at the code generator front.
There have also been a few people that want to integrate existing documentation tools better with the Lean stuff like LeanInk so maybe this would be the place for documentation like this to live? I'm unsure, where to put what documentation is still an open question :/
from doc-gen4.
The prose itself isn't really what matters here; it's primarily about being able to ask "what instances does mathlib put on pi types", which is very much directly related to code. The components of doing so are roughly:
- finding somewhere to emit "Instances for" for these special builtin types. If you don't want to write any prose, don't bother. Headings alone is enough for now.
- modifying the scraping component to detect typeclasses on pi and Prop etc (you might already have code that does this if you copied it from doc-gen 3)
- Modifying the Lean4 equivalent of
pp.links
to attach links to these builtin types
from doc-gen4.
I do have an implementation in #93 for sort variants. I am not yet sure how to do pi types in the current framework. It might be that this requires a patch similar to the one we had for function applications with constants in the compiler.
from doc-gen4.
Related Issues (20)
- important type info is omitted HOT 3
- error: no such file or directory HOT 4
- ERROR: could not execute external process 'cc' HOT 2
- @[reducible] attributes are not shown HOT 1
- Hyperlinking not working when an up-arrow occurs before the declaration name
- Implement references / bibliography HOT 7
- Unclear error when running in a git repo without "origin" remote HOT 1
- Lean statement not rendered for theorems defined as `def thm : Prop := statement`
- Improve UX for long instance names HOT 1
- instances for vs instances mentioning
- Show data fields only to avoid "not rendered due to size" HOT 1
- Put inductive/structure documentation before field documentation HOT 3
- Auto-generated lemmas appear before declaration HOT 1
- De-indent comment block HOT 3
- Empty instances for HOT 1
- Escape sequences are handled incorrectly in LaTeX HOT 9
- Support for protected modifier
- auto-generated structure projections not appearing HOT 2
- noncomputable section isn't shown anywhere HOT 2
- Clicking links in the navbar or using the "Go to source" link produces an error in VS Code webviews
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 doc-gen4.