Euphoria Ticket #820: some routines are not documented in 4.1

The routines sizeof poke_pointer, peek_pointer and get_key are not documented After generating the HTML docs, the unix command 'grep -r unres | wc -l' results in the number of places in the docs where we don't have some commands documented.

Details

Type: Bug Report Severity: Major Category: Documentation
Assigned To: mattlewis Status: Fixed Reported Release: 4.1.0
Fixed in SVN #: View VCS: none Milestone: 4.1.0

1. Comment by ne1uno Nov 18, 2012

some of these might already be started/done in the structs branch. sizeof and get_key are. assuming there are no creole errors causing them to be skipped

2. Comment by DerekParnell Jan 16, 2013

I can document these if someone can let me know which are missing. I don't do unix here so the suggested grep command is not going to work for me.

Also, I downgraded the severity as this is not actually blocking the release though it is a major issue.

3. Comment by mattlewis Jan 16, 2013

Following the above advice, I find:

  • peek_pointer
  • poke_pointer
  • poke8
  • sizeof

get_key seems to be showing up in the std/console.e documentation, which seems correct.

4. Comment by mattlewis Jan 16, 2013

Also, "Binding and Shrouding" is coming up as unresolved in distributing.html:

For more information about shrouding and binding, see <a href="unresolved.html">Binding and Shrouding</a>. 

5. Comment by jimcbrown Jan 21, 2013

You can get grep and wc for Windoze from http://unxutils.sourceforge.net/

Alternatively, you can try using the PowerShell equivalents: http://windows-powershell-scripts.blogspot.com/2009/06/unix-equivalents-in-powershell.html

In this case:

Select-String "unres" | Measure-Object -line

6. Comment by mattlewis Mar 01, 2013

See: hg:euphoria/rev/a36bb177d0ef

changeset: 6014:a36bb177d0ef tag: tip user: Matt Lewis date: Fri Mar 01 13:11:41 2013 -0500 files: docs/release/4.1.0.txt docs/using_euphoria.txt include/std/dll.e include/std/machine.e description:

  • document missing poke / peek /sizeof built in
  • fixed some other documentation references
  • fixes ticket 820

Search



Quick Links

User menu

Not signed in.

Misc Menu