sparklemotion/nokogiri

[doc] Document memory management model

Open

#2,183 opened on Feb 1, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Ruby (806 forks)batch import
help wantedtopic/documentation

Repository metrics

Stars
 (5,615 stars)
PR merge metrics
 (Avg merge 1d 7h) (14 merged PRs in 30d)

Description

This issue comment should be expanded upon and made into a page explaining how we deal with libxml2's memory model within Ruby's mark-and-sweep GC model:

https://github.com/sparklemotion/nokogiri/issues/1952#issuecomment-770856928

Contributor guide

Research direction
Read the linked comment and create a new documentation page explaining how Nokogiri integrates libxml2's memory model with Ruby's mark and sweep GC.
Tech stack
ruby
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitRuby
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70