Skip to content
This repository has been archived by the owner on Dec 6, 2024. It is now read-only.

Doc - Describe setup_hint_processor using Rustdoc comments (three slashes: ///) #58

Open
Eikix opened this issue Nov 24, 2022 · 3 comments · May be fixed by #121
Open

Doc - Describe setup_hint_processor using Rustdoc comments (three slashes: ///) #58

Eikix opened this issue Nov 24, 2022 · 3 comments · May be fixed by #121
Labels
Context: isolated no previous knowledge of the codebase required Difficulty: easy anybody can understand it Duration: 0.5 day will take about half a day Good First Issue Techno: rust rust Type: documentation write documentation

Comments

@Eikix
Copy link
Collaborator

Eikix commented Nov 24, 2022

In an effort of having fully documented code, we need the way we add custom hints (mocking calls, skipping instructions, expecting revert) to be documented.

In src/cli/commands/test, please proceed to comment above the fn setup_hint_processor declaration in an equivalent way as pub fn compile is documented.

@Eikix Eikix added Type: documentation write documentation Context: isolated no previous knowledge of the codebase required Difficulty: easy anybody can understand it Techno: rust rust Duration: 0.5 day will take about half a day Good First Issue labels Nov 24, 2022
@Eikix Eikix moved this to Done ✅ in Cairo foundry Nov 30, 2022
@Eikix Eikix moved this from Done ✅ to Todo 🗃️ in Cairo foundry Nov 30, 2022
@Eikix Eikix added this to the Onboarding Experience ✅ milestone Nov 30, 2022
@jdembdr
Copy link
Contributor

jdembdr commented Jan 9, 2023

Ready to go.

jdembdr pushed a commit to jdembdr/cairo-foundry that referenced this issue Jan 9, 2023
jdembdr pushed a commit to jdembdr/cairo-foundry that referenced this issue Jan 9, 2023
@RuneRogue
Copy link

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a blockchain and DeFi developer . I am having experience of 8 months . I am currently working as a Blockchain Researcher and Developer. My Experience in programming language like Go , Rust , Java will help me to solve this issue.

@RomThpt
Copy link

RomThpt commented Dec 6, 2024

Could I grab this task?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Context: isolated no previous knowledge of the codebase required Difficulty: easy anybody can understand it Duration: 0.5 day will take about half a day Good First Issue Techno: rust rust Type: documentation write documentation
Projects
None yet
4 participants