Comments (3)
NathanLovato
commented on August 12, 2024
What should be the markup for that? The Godot class reference uses square brackets, i.e. [method_in_this_class], [ClassName], and [ClassName.method] respectively. Should we use the same for consistency?
from gdscript-docs-maker.
Razoric480
commented on August 12, 2024
I'm not sure I see what you mean regarding [square brackets], as I can't find any. I thought you meant at the source level, but the docs use
just found the XML files
That said, just going [create_path], [GSAIPath], and [GSAIPath.create_path] does sound pretty simple. So long as we remember to add a space if we intend on then wrapping some follow-up texts in parenthesis.
from gdscript-docs-maker.
NathanLovato
commented on August 12, 2024
Okay let's try that. Anyway it's easy to change before releasing the update.
from gdscript-docs-maker.
Related Issues (20)
- Add ability to ignore any property based on metadata
- It doesn't work as it should HOT 2
- build_re_pattern is missing
- Script did not work, lots of errors HOT 1
- Can't get it to work without modifying ReferenceCollectorCLI.gd HOT 3
- Support godot <3.1 HOT 7
- Support for nested lists in markdown HOT 1
- Links to Extensions which are core Godot classes, should link to the official documentation HOT 1
- const documentation is not being produced consitently.
- index is being generated blank HOT 3
- Broken `pip install gdscript_docs_maker`? HOT 1
- generate_reference not filtering directories. HOT 1
- generate-reference.bat fails when folder paths contains whitespaces HOT 4
- Display errors of scripts in terminal
- Replicate folder structure option for generate-ref script
- Support for license boilerplate text HOT 5
- Exclude warning ignore comments HOT 2
- Running gdscript_docs_maker.__main__ on reference.json
- KeyError: 'name' while generating markdown files HOT 4
- Dockerfile: The file /game/reference.json was not found 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 gdscript-docs-maker.