Comments (4)
Thanks, Ningyuan and Eldric for your input. So it seems that my original proposal is getting your approval.
FYI: With Eldric, I have discussed documentation of libraries and we think that there are ways to put together a library document using JSDoc and the functions selected in the assessment XML via <SYMBOL>
.
from modules.
I've been discussing the documentation of the library functions with @blackening . We can generate the documentation of the libraries using tools like JSDoc. In that case, all exported functions would show up in the document, regardless of what functions the mission author decides to import. In other words, there may be functions in the module documentation that are not actually imported by the author of the mission. So perhaps we need to insist that all functions that are exported by a module are also imported in the mission? In that case, maybe we should not require that the author of the mission lists the imported functions using <SYMBOL>
tags, and instead import all exported functions? The tag would be simply like this:
<IMPORT module="cs1101s_1920/two_dim_runes"/>
from modules.
The SYMBOL tag will allow assessment authors to selectively import only what they want to import. So if for any reason there is some part of an external library that the assessment author wishes to omit to the student, they can import selectively via SYMBOL tags.
Admittedly, the scenario itself is rather troublesome. Historically, selective imports hid functions because students are being asked to write those exact same functions. They could easily inspect the external library from their browser to find the answer.
Either way, I think it is also good not to crowd the global namespace with unnecessary functions.
from modules.
See: https://github.com/source-academy/assessments/wiki/Assessments#import
postponed till 20/21
from modules.
Related Issues (20)
- [RUNE]: Split documentation's functions into categories
- [CURVE]: Cyclic imports
- [MODULES]: Module tab persists after a new non-module program is run with breakpoint for Env Visualizer HOT 1
- Memory Leak on Mission "Beyond the Second Dimension"
- Upgrade blueprint js version in modules repository to match frontend HOT 1
- Build process's flag does not actually skip HTML documentation HOT 2
- Build process always builds all tabs HOT 1
- Build process always retries building JSONs for unupdated bundles without documentation HOT 1
- Mobile Workspace: Module tab reloading on each keystroke in editor HOT 4
- [RUNE]: heart has too low resolution HOT 3
- Runes: More visual feedback needed HOT 2
- Sounds: More immediate audio feedback needed HOT 2
- New compile system crashes site when rendering tab HOT 2
- Modules broken HOT 1
- [Feature Request]: Modularise remote execution
- [Build System]: Template command does not verify snake case properly HOT 1
- Standardize Line Encodings HOT 4
- Improvement on externalize React for React usages inside bundle codes HOT 14
- Sounds: long-established demo no longer working properly HOT 7
- [CSG 2.0]: Side buttons not clickable HOT 3
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 modules.