Bioconductor / BiocParallel

Bioconductor facilities for parallel evaluation
https://bioconductor.org/packages/BiocParallel
65 stars 29 forks source link

Extremely minor: typo in docs? man/MulticoreParam-class.Rd #258

Closed adam-cornwell closed 6 months ago

adam-cornwell commented 8 months ago

MulticoreParam force.GC: "logical(1) Whether to invoke the garbage collector after each call to FUN. The value TRUE, explicitly call the garbage collection, can slow parallel computation, but is necessary when each call to FUN allocates a 'large' amount of memory. If FUN allocates little memory, then considerable performance improvements are gained by the default setting force.GC = TRUE. "

The default setting is "FALSE" and it's pretty likely that setting it to TRUE when it's not necessary would reduce performance.

About the most minor possible issue but wanted to point it out. I figured it wasn't worth a pull request. Thanks!

mtmorgan commented 6 months ago

Sorry to be so slow!