Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
GitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
regexp: hard to find documentation for 'n' #14581
Please answer these questions before submitting your issue. Thanks!
Initially I ended up finding my answer on a stack overflow question, but later it was pointed out that the 'n' parameter is documented in the package level documentation. The package level documentation is well written and would have answered my question, but it is currently very difficult to find. Part of the problem is that it is within a paragraph so it is not easy to just browse to it and searching the page for 'n' is also not efficient.
Two solutions that come to mind are documenting the parameter on the functions that use it or maybe just renaming it to something searchable like
It says "as defined by the 'All' description in the package comment". It sounds like you missed that clause, which I understand, but it's not clear that there's much to do. Docs will be misread, Stack Overflow and other sites will help.