Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation, slighly reorganize collector code #31

Merged
merged 1 commit into from Jun 15, 2020

Conversation

Others
Copy link
Owner

@Others Others commented Jun 14, 2020

Should make the collector a little easier to follow.

Resolves #30 for now

@seanchen1991 can you take a look at this?

seanchen1991
seanchen1991 previously approved these changes Jun 14, 2020
Copy link

@seanchen1991 seanchen1991 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding these! I agree they make reading through the collector module easier 🙂

@@ -422,6 +453,7 @@ impl Collector {
// Now cleanup by removing all the data that is done for
par_retain(&self.tracked_data.data, |data, _| {
// Mark the new data as in use for now
// This stops us blinding data that was allocated during collection

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you meant “building” instead of “blinding” here? Not 100% sure, but it seems like a typo.

@@ -386,6 +415,8 @@ impl Collector {

// eprintln!("roots {:?}", roots);

// This step is dfs through the object graph (strating with the roots)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Misspelled “starting” here.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what I get for writing comments while tired... Will push fix tomorrow

Should make the collector a little easier to follow
@Others Others merged commit 3cb168a into master Jun 15, 2020
@Others Others deleted the document_collector branch August 20, 2020 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation to Collector
2 participants